Skip to content

Initial Proposal: Make Worker-Deployment API's async in nature. #639

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
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Initial Proposal: Make Worker-Deployment API's async in nature. #639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f9de3f3
initial proposal
Shivs11 Sep 16, 2025
95d2167
propagation status enum
Shivs11 Sep 18, 2025
1f5cc05
Merge branch 'master' into ss/async-worker-deployments
Shivs11 Sep 18, 2025
24c7b3b
comment
Shivs11 Sep 18, 2025
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
15 changes: 15 additions & 0 deletions openapi/openapiv2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14083,9 +14083,24 @@
"type": "string",
"format": "date-time",
"description": "Last time ramping version percentage was changed.\nIf ramping version is changed, this is also updated, even if the percentage stays the same."
},
"routingConfigUpdateState": {
"$ref": "#/definitions/v1RoutingConfigUpdateState",
"description": "Indicates whether the routing_config has been fully propagated to all\nrelevant task queues and their partitions."
}
}
},
"v1RoutingConfigUpdateState": {
"type": "string",
"enum": [
"ROUTING_CONFIG_UPDATE_STATE_UNSPECIFIED",
"ROUTING_CONFIG_UPDATE_STATE_IN_PROGRESS",
"ROUTING_CONFIG_UPDATE_STATE_COMPLETED",
"ROUTING_CONFIG_UPDATE_STATE_FAILED"
],
"default": "ROUTING_CONFIG_UPDATE_STATE_UNSPECIFIED",
"description": "Indicates whether a change to the Routing Config has been\npropagated to all relevant Task Queues and their partitions.\n\n - ROUTING_CONFIG_UPDATE_STATE_IN_PROGRESS: Update to the RoutingConfig is currently in progress.\n - ROUTING_CONFIG_UPDATE_STATE_COMPLETED: Update to the RoutingConfig has completed successfully.\n - ROUTING_CONFIG_UPDATE_STATE_FAILED: Update to the RoutingConfig has failed."
},
"v1ScanWorkflowExecutionsResponse": {
"type": "object",
"properties": {
Expand Down
11 changes: 11 additions & 0 deletions openapi/openapiv3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11060,6 +11060,17 @@ components:
Last time ramping version percentage was changed.
If ramping version is changed, this is also updated, even if the percentage stays the same.
format: date-time
routingConfigUpdateState:
enum:
- ROUTING_CONFIG_UPDATE_STATE_UNSPECIFIED
- ROUTING_CONFIG_UPDATE_STATE_IN_PROGRESS
- ROUTING_CONFIG_UPDATE_STATE_COMPLETED
- ROUTING_CONFIG_UPDATE_STATE_FAILED
type: string
description: |-
Indicates whether the routing_config has been fully propagated to all
relevant task queues and their partitions.
format: enum
Schedule:
type: object
properties:
Expand Down
3 changes: 3 additions & 0 deletions temporal/api/deployment/v1/message.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,7 @@ message RoutingConfig {
// Last time ramping version percentage was changed.
// If ramping version is changed, this is also updated, even if the percentage stays the same.
google.protobuf.Timestamp ramping_version_percentage_changed_time = 6;
// Indicates whether the routing_config has been fully propagated to all
// relevant task queues and their partitions.
temporal.api.enums.v1.RoutingConfigUpdateState routing_config_update_state = 10;
}
12 changes: 12 additions & 0 deletions temporal/api/enums/v1/task_queue.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,15 @@ enum RateLimitSource {
// The value was set as the system default.
RATE_LIMIT_SOURCE_SYSTEM = 3;
}

// Indicates whether a change to the Routing Config has been
// propagated to all relevant Task Queues and their partitions.
enum RoutingConfigUpdateState {
ROUTING_CONFIG_UPDATE_STATE_UNSPECIFIED = 0;
// Update to the RoutingConfig is currently in progress.
ROUTING_CONFIG_UPDATE_STATE_IN_PROGRESS = 1;
// Update to the RoutingConfig has completed successfully.
ROUTING_CONFIG_UPDATE_STATE_COMPLETED = 2;
// Update to the RoutingConfig has failed.
ROUTING_CONFIG_UPDATE_STATE_FAILED = 3;
Copy link
Contributor

Choose a reason for hiding this comment

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

if we do keep an internal timeout (such as 10m or 5m) and the update times out, would that cause it to be in failed state?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

}
Loading