gcp_cloud_run_worker_id: use CloudRunPlugin

Register temporalio.contrib.gcp.cloud_run.CloudRunPlugin on the client
via Client.connect(plugins=[...]) instead of manually fetching metadata
and passing identity= and deployment_config=. The plugin sets the client
identity and the PINNED worker deployment config from Cloud Run instance
metadata and propagates to the worker automatically.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Author: seanbollin

gcp_cloud_run_worker_id/README.md

@@ -3,23 +3,26 @@
 This sample runs a long-lived Temporal Worker in a [Google Cloud Run worker
 pool](https://cloud.google.com/run/docs/worker-pools) and uses the
 [`temporalio.contrib.gcp.cloud_run`](https://python.temporal.io/temporalio.contrib.gcp.cloud_run.html)
-helper to derive the worker's identity and its Worker Deployment version from
-Cloud Run instance metadata.
+`CloudRunPlugin` to derive the worker's identity and its Worker Deployment
+version from Cloud Run instance metadata.
 
 Cloud Run runs a long-lived container rather than a per-invocation handler, so
-this is a small metadata helper -- not a worker wrapper. At startup the worker
-calls `get_google_cloud_run_metadata()`, which:
+this is a small metadata-driven plugin -- not a worker wrapper. The worker
+registers `CloudRunPlugin()` on the client via `Client.connect(plugins=[...])`.
+At connect time the plugin:
 
 - reads the deployment name from `CLOUD_RUN_WORKER_POOL` (worker pools), falling
   back to `K_SERVICE` (services);
 - reads the revision from `CLOUD_RUN_REVISION`, falling back to `K_REVISION`;
 - fetches this container's unique instance id from the Cloud Run metadata server.
 
-From that it produces a worker `identity` of `<instance_id>@<revision>` and a
-`WorkerDeploymentConfig` (deployment name = worker-pool name, build id =
-revision) with Worker Versioning enabled and a **PINNED** default versioning
-behavior. The sample registers a simple greeting Workflow and Activity, but the
-pattern applies to any Workflow/Activity definitions.
+From that it sets the client `identity` to `<instance_id>@<revision>` (unless you
+passed one) and configures the worker with a `WorkerDeploymentConfig` (deployment
+name = worker-pool name, build id = revision) with Worker Versioning enabled and
+a **PINNED** default versioning behavior. Client plugins propagate to workers
+automatically, so there is nothing to wire up on the `Worker`. The sample
+registers a simple greeting Workflow and Activity, but the pattern applies to any
+Workflow/Activity definitions.
 
 > **Worker pools vs. services.** A Cloud Run *worker pool* has no HTTP endpoint;
 > it is designed for long-running background workloads such as a Temporal
@@ -38,7 +41,7 @@ pattern applies to any Workflow/Activity definitions.
 
 | File | Description |
 |------|-------------|
-| `worker.py` | Long-lived worker: derives identity + deployment version from Cloud Run metadata, then runs until SIGTERM |
+| `worker.py` | Long-lived worker: registers `CloudRunPlugin` to set identity + deployment version from Cloud Run metadata, then runs until SIGTERM |
 | `workflows.py` | Sample Workflow that executes a greeting Activity (PINNED versioning behavior) |
 | `activities.py` | Sample Activity that returns a greeting string |
 | `settings.py` | Reads `TEMPORAL_*` connection settings from the environment |

gcp_cloud_run_worker_id/pyproject.toml

@@ -17,8 +17,8 @@ dev = [
 [tool.uv]
 package = false
 
-# TEMPORARY: the Google Cloud Run metadata helper
-# (temporalio.contrib.gcp.cloud_run.get_google_cloud_run_metadata) is not
+# TEMPORARY: the Google Cloud Run plugin
+# (temporalio.contrib.gcp.cloud_run.CloudRunPlugin) is not
 # released yet, so this pins `temporalio` to the local SDK checkout on the
 # `cloud-run-worker-id` branch so the sample can be run and type-checked
 # locally. Remove this [tool.uv.sources] override and rely on the released

gcp_cloud_run_worker_id/worker.py

@@ -1,9 +1,10 @@
 """Run a long-lived Temporal worker on a Google Cloud Run worker pool.
 
-The worker derives its identity and a PINNED Worker Deployment version from
-Cloud Run instance metadata using
-``temporalio.contrib.gcp.cloud_run.get_google_cloud_run_metadata`` and runs
-until Cloud Run sends SIGTERM (for example, on scale-down).
+The worker registers ``temporalio.contrib.gcp.cloud_run.CloudRunPlugin`` on the
+client. The plugin reads Cloud Run instance metadata and automatically sets the
+client identity and a PINNED Worker Deployment version, then propagates to the
+worker. The worker runs until Cloud Run sends SIGTERM (for example, on
+scale-down).
 """
 
 from __future__ import annotations
@@ -14,24 +15,26 @@
 from activities import compose_greeting
 from settings import load_settings
 from temporalio.client import Client
-from temporalio.contrib.gcp.cloud_run import get_google_cloud_run_metadata
+from temporalio.contrib.gcp.cloud_run import CloudRunPlugin
 from temporalio.worker import Worker
 from workflows import GreetingWorkflow
 
 
 async def main() -> None:
     settings = load_settings()
 
-    # Reads CLOUD_RUN_WORKER_POOL/CLOUD_RUN_REVISION (worker pools) or
-    # K_SERVICE/K_REVISION (services) and fetches this instance's unique id from
-    # the Cloud Run metadata server. Raises if not running on Cloud Run.
-    metadata = get_google_cloud_run_metadata()
-
+    # The plugin reads CLOUD_RUN_WORKER_POOL/CLOUD_RUN_REVISION (worker pools) or
+    # K_SERVICE/K_REVISION (services), fetches this instance's unique id from the
+    # Cloud Run metadata server at connect time, and raises if not running on
+    # Cloud Run. It sets the client identity to <instance_id>@<revision> (so each
+    # running container is identifiable) and configures the worker with a
+    # deployment config that enables Worker Versioning -- deployment name =
+    # worker-pool name, build id = Cloud Run revision -- with a PINNED default
+    # versioning behavior. Client plugins propagate to workers automatically.
     client = await Client.connect(
         settings.address,
         namespace=settings.namespace,
-        # <instance_id>@<revision>, so each running container is identifiable.
-        identity=metadata.worker_identity,
+        plugins=[CloudRunPlugin()],
         api_key=settings.api_key,
         tls=settings.tls,
     )
@@ -41,9 +44,6 @@ async def main() -> None:
         task_queue=settings.task_queue,
         workflows=[GreetingWorkflow],
         activities=[compose_greeting],
-        # Enables Worker Versioning: deployment name = worker-pool name, build
-        # id = Cloud Run revision, with a PINNED default versioning behavior.
-        deployment_config=metadata.worker_deployment_config,
     )
 
     loop = asyncio.get_running_loop()
@@ -60,12 +60,10 @@ def request_shutdown() -> None:
     for signum in (signal.SIGTERM, signal.SIGINT):
         loop.add_signal_handler(signum, request_shutdown)
 
-    version = metadata.worker_deployment_version
+    # identity was set by CloudRunPlugin from Cloud Run instance metadata.
     print(
         "Worker starting "
-        f"identity={metadata.worker_identity} "
-        f"deployment={version.deployment_name} "
-        f"build_id={version.build_id} "
+        f"identity={client.identity} "
         f"task_queue={settings.task_queue}",
         flush=True,
     )