Skip to content

feature: add compute provider to worker deployment #704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaypipes wants to merge 1 commit into
base: master
Choose a base branch
from
+386 −6
Open

feature: add compute provider to worker deployment #704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions buf.lock
View file
Open in desktop
Copy link

@02strich 02strich Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this change intentional?

Copy link
Author

@jaypipes jaypipes Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no... it happened when I ran make buf-lint locally :(

Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,3 @@ deps:
repository: googleapis
commit: 28151c0d0a1641bf938a7672c500e01d
digest: shake256:49215edf8ef57f7863004539deff8834cfb2195113f0b890dd1f67815d9353e28e668019165b9d872395871eeafcbab3ccfdb2b5f11734d3cca95be9e8d139de
- remote: buf.build
owner: grpc-ecosystem
repository: grpc-gateway
commit: 048ae6ff94ca4476b3225904b1078fad
digest: shake256:e5250bf2d999516c02206d757502b902e406f35c099d0e869dc3e4f923f6870fe0805a9974c27df0695462937eae90cd4d9db90bb9a03489412560baa74a87b6
135 changes: 135 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2559,6 +2559,52 @@
]
}
},
"/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/update-compute-provider": {
"post": {
"summary": "Creates or replaces the compute provider configuration for a Worker\nDeployment.",
"description": "If a Worker Deployment with the supplied name does not exist, this\ncommand will create a new Worker Deployment with the supplied name.\n\nExperimental. This API might significantly change or be removed in a\nfuture release.",
"operationId": "UpdateWorkerDeploymentComputeProvider2",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UpdateWorkerDeploymentComputeProviderResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowServiceUpdateWorkerDeploymentComputeProviderBody"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/api/v1/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
Expand Down Expand Up @@ -6723,6 +6769,52 @@
]
}
},
"/namespaces/{namespace}/worker-deployments/{deploymentName}/update-compute-provider": {
"post": {
"summary": "Creates or replaces the compute provider configuration for a Worker\nDeployment.",
"description": "If a Worker Deployment with the supplied name does not exist, this\ncommand will create a new Worker Deployment with the supplied name.\n\nExperimental. This API might significantly change or be removed in a\nfuture release.",
"operationId": "UpdateWorkerDeploymentComputeProvider",
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/v1UpdateWorkerDeploymentComputeProviderResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/rpcStatus"
}
}
},
"parameters": [
{
"name": "namespace",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deploymentName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/WorkflowServiceUpdateWorkerDeploymentComputeProviderBody"
}
}
],
"tags": [
"WorkflowService"
]
}
},
"/namespaces/{namespace}/worker-task-reachability": {
"get": {
"summary": "Deprecated. Use `DescribeTaskQueue`.",
Expand Down Expand Up @@ -9910,6 +10002,25 @@
}
}
},
"WorkflowServiceUpdateWorkerDeploymentComputeProviderBody": {
"type": "object",
"properties": {
"computeProvider": {
"$ref": "#/definitions/v1ComputeProvider",
"description": "Contains the new worker compute provider configuration for the\nWorkerDeployment."
},
"conflictToken": {
"type": "string",
"format": "byte",
"description": "Optional. This can be the value of conflict_token from a Describe or\nanother UpdateWorkerDeploymentComputeProvider API call.\n\nPassing a non-nil conflict token will cause this request to fail if the\nWorkerDeployment's configuration has been modified between the API call\nthat generated the token and this one."
},
"identity": {
"type": "string",
"description": "Optional. The identity of the client who initiated this request."
}
},
"description": "Creates or Replaces the worker lifecycle configuration for a\nWorkerDeployment."
},
"WorkflowServiceUpdateWorkerDeploymentVersionMetadataBody": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -11339,6 +11450,16 @@
},
"description": "Used by the worker versioning APIs, represents an unordered set of one or more versions which are\nconsidered to be compatible with each other. Currently the versions are always worker build IDs."
},
"v1ComputeProvider": {
"type": "object",
"properties": {
"providerDetails": {
"$ref": "#/definitions/v1Payload",
"description": "We use Payload here because the configuration may include secret\ninformation.\n\nAn individual ComputeProviderAWSLambda,\nComputeProviderGoogleCloudRun, etc will be encrypted and\nserialized into compute_provider_config."
}
},
"description": "ComputeProvider stores information used by a worker control plane controller\nto respond to worker lifecycle events. For example, when a Task is received\non a TaskQueue that has no active pollers in the last five minutes, a\nserverless worker lifecycle controller might need to invoke an AWS Lambda\nFunction that itself ends up calling the SDK's worker.New() function."
},
"v1ConfigMetadata": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -16020,6 +16141,16 @@
}
}
},
"v1UpdateWorkerDeploymentComputeProviderResponse": {
"type": "object",
"properties": {
"conflictToken": {
"type": "string",
"format": "byte",
"description": "This value is returned so that it can be optionally passed to APIs that\nwrite to the WorkerDeployment state to ensure that the state did not\nchange between this API call and a future write."
}
}
},
"v1UpdateWorkerDeploymentVersionMetadataResponse": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -16280,6 +16411,10 @@
"routingConfigUpdateState": {
"$ref": "#/definitions/v1RoutingConfigUpdateState",
"description": "Indicates whether the routing_config has been fully propagated to all\nrelevant task queues and their partitions."
},
"computeProvider": {
"$ref": "#/definitions/v1ComputeProvider",
"description": "Contains information used by worker control plane controllers to handle\nscale events."
}
},
"description": "A Worker Deployment (Deployment, for short) represents all workers serving \na shared set of Task Queues. Typically, a Deployment represents one service or \napplication.\nA Deployment contains multiple Deployment Versions, each representing a different \nversion of workers. (see documentation of WorkerDeploymentVersionInfo)\nDeployment records are created in Temporal server automatically when their\nfirst poller arrives to the server.\nExperimental. Worker Deployments are experimental and might significantly change in the future."
Expand Down
152 changes: 152 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2302,6 +2302,50 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/worker-deployments/{deploymentName}/update-compute-provider:
post:
tags:
- WorkflowService
description: |-
Creates or replaces the compute provider configuration for a Worker
Deployment.

If a Worker Deployment with the supplied name does not exist, this
command will create a new Worker Deployment with the supplied name.

Experimental. This API might significantly change or be removed in a
future release.
operationId: UpdateWorkerDeploymentComputeProvider
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerDeploymentComputeProviderRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerDeploymentComputeProviderResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/api/v1/namespaces/{namespace}/worker-task-reachability:
get:
tags:
Expand Down Expand Up @@ -6038,6 +6082,50 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/worker-deployments/{deploymentName}/update-compute-provider:
post:
tags:
- WorkflowService
description: |-
Creates or replaces the compute provider configuration for a Worker
Deployment.

If a Worker Deployment with the supplied name does not exist, this
command will create a new Worker Deployment with the supplied name.

Experimental. This API might significantly change or be removed in a
future release.
operationId: UpdateWorkerDeploymentComputeProvider
parameters:
- name: namespace
in: path
required: true
schema:
type: string
- name: deploymentName
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerDeploymentComputeProviderRequest'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkerDeploymentComputeProviderResponse'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/namespaces/{namespace}/worker-task-reachability:
get:
tags:
Expand Down Expand Up @@ -8526,6 +8614,25 @@ components:
description: |-
Used by the worker versioning APIs, represents an unordered set of one or more versions which are
considered to be compatible with each other. Currently the versions are always worker build IDs.
ComputeProvider:
type: object
properties:
providerDetails:
allOf:
- $ref: '#/components/schemas/Payload'
description: |-
We use Payload here because the configuration may include secret
information.

An individual ComputeProviderAWSLambda,
ComputeProviderGoogleCloudRun, etc will be encrypted and
serialized into compute_provider_config.
description: |-
ComputeProvider stores information used by a worker control plane controller
to respond to worker lifecycle events. For example, when a Task is received
on a TaskQueue that has no active pollers in the last five minutes, a
serverless worker lifecycle controller might need to invoke an AWS Lambda
Function that itself ends up calling the SDK's worker.New() function.
ConfigMetadata:
type: object
properties:
Expand Down Expand Up @@ -14342,6 +14449,45 @@ components:
allOf:
- $ref: '#/components/schemas/WorkerConfig'
description: The worker configuration. Will be returned if the command was sent to a single worker.
UpdateWorkerDeploymentComputeProviderRequest:
type: object
properties:
namespace:
type: string
deploymentName:
type: string
computeProvider:
allOf:
- $ref: '#/components/schemas/ComputeProvider'
description: |-
Contains the new worker compute provider configuration for the
WorkerDeployment.
conflictToken:
type: string
description: |-
Optional. This can be the value of conflict_token from a Describe or
another UpdateWorkerDeploymentComputeProvider API call.

Passing a non-nil conflict token will cause this request to fail if the
WorkerDeployment's configuration has been modified between the API call
that generated the token and this one.
format: bytes
identity:
type: string
description: Optional. The identity of the client who initiated this request.
description: |-
Creates or Replaces the worker lifecycle configuration for a
WorkerDeployment.
UpdateWorkerDeploymentComputeProviderResponse:
type: object
properties:
conflictToken:
type: string
description: |-
This value is returned so that it can be optionally passed to APIs that
write to the WorkerDeployment state to ensure that the state did not
change between this API call and a future write.
format: bytes
UpdateWorkerDeploymentVersionMetadataRequest:
type: object
properties:
Expand Down Expand Up @@ -14718,6 +14864,12 @@ components:
Indicates whether the routing_config has been fully propagated to all
relevant task queues and their partitions.
format: enum
computeProvider:
allOf:
- $ref: '#/components/schemas/ComputeProvider'
description: |-
Contains information used by worker control plane controllers to handle
scale events.
description: "A Worker Deployment (Deployment, for short) represents all workers serving \n a shared set of Task Queues. Typically, a Deployment represents one service or \n application.\n A Deployment contains multiple Deployment Versions, each representing a different \n version of workers. (see documentation of WorkerDeploymentVersionInfo)\n Deployment records are created in Temporal server automatically when their\n first poller arrives to the server.\n Experimental. Worker Deployments are experimental and might significantly change in the future."
WorkerDeploymentInfo_WorkerDeploymentVersionSummary:
type: object
Expand Down
Loading
Loading