Serverless Workers on GCP Cloud Run - TypeScript SDK

View Markdown

On a GCP Cloud Run worker pool, you run a standard long-lived Temporal Worker. Register Workflows and Activities the same way you would with any other TypeScript Worker, and Temporal Cloud scales the pool up and down as work arrives and drains.

A Cloud Run Worker needs no Cloud Run-specific package. The one addition to a standard Worker is Worker Versioning, which is required for Serverless Workers.

For the end-to-end deployment guide covering the Worker Pool, IAM, and compute configuration, see Deploy a Serverless Worker on GCP Cloud Run.

Create a versioned Worker

Build the Worker as you would any long-running TypeScript Worker, then pass workerDeploymentOptions to Worker.create() to declare the Worker Deployment Version and turn versioning on.

The following Worker reads its connection settings and Task Queue from the environment, so the same image can run against any Namespace:

import { loadClientConnectConfig } from '@temporalio/envconfig';
import { NativeConnection, Worker } from '@temporalio/worker';
import * as activities from './activities';

async function run() {
  const config = loadClientConnectConfig();
  const connection = await NativeConnection.connect(config.connectionOptions);

  const worker = await Worker.create({
    connection,
    namespace: config.namespace,
    taskQueue: process.env.TEMPORAL_TASK_QUEUE!,
    workflowsPath: require.resolve('./workflows'),
    activities,
    workerDeploymentOptions: {
      version: { deploymentName: 'my-app', buildId: 'build-1' },
      useWorkerVersioning: true,
      defaultVersioningBehavior: 'PINNED',
    },
  });

  await worker.run();
}

run().catch((err) => {
  console.error(err);
  process.exit(1);
});

deploymentName and buildId together identify the Worker Deployment Version. Both values must match the version you create with temporal worker deployment create-version in the deployment guide, or the Worker polls under a version the WCI does not manage.

Every Workflow needs a versioning behavior, either PINNED or AUTO_UPGRADE. Setting defaultVersioningBehavior as shown above covers every Workflow on the Worker. To set the behavior per Workflow instead, pass the Workflow function to setWorkflowOptions() from @temporalio/workflow:

import { setWorkflowOptions } from '@temporalio/workflow';

setWorkflowOptions({ versioningBehavior: 'PINNED' }, myWorkflow);
export async function myWorkflow(): Promise<string> {
  // ...
}

For general Worker setup and options that are not specific to Cloud Run, see Run a Worker.

Configure the Temporal connection

The @temporalio/envconfig package loads Temporal Client configuration from environment variables and an optional TOML config file, so the Worker code carries no Namespace or credentials. Set the non-secret values as environment variables on the Worker Pool, and mount the Temporal Cloud API key or TLS material from Secret Manager. For the full list of supported variables, the config file format, and profiles, see Environment configuration.

loadClientConnectConfig() returns connectionOptions and namespace. Pass connectionOptions to NativeConnection.connect() and namespace to Worker.create(), as shown above.

Keep Activities safe across scale-in

The WCI decides when to remove an instance from Task Queue activity, not from what an individual instance is doing. An instance running a long Activity can be stopped mid-execution.

Use Activity Heartbeats so a retry resumes from the last recorded progress instead of starting over:

import { heartbeat } from '@temporalio/activity';

export async function myActivity(items: string[]): Promise<string> {
  for (let i = 0; i < items.length; i++) {
    heartbeat(i);
    // ... process items[i]
  }
  return 'done';
}

For how scale-in decisions are made, see Serverless Workers on GCP Cloud Run.

Add observability

A Cloud Run Worker emits the same traces and metrics as a Worker anywhere else. For how to configure metrics export and OpenTelemetry tracing interceptors, see Observability - TypeScript SDK and the SDK metrics reference.

Create a versioned Worker​

Configure the Temporal connection​

Keep Activities safe across scale-in​

Add observability​

Create a versioned Worker

Configure the Temporal connection

Keep Activities safe across scale-in

Add observability