Skip to content
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.

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

flag for ramping #542

Merged
merged 1 commit into from
Jan 31, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions openapi/openapiv2.json
Original file line number Diff line number Diff line change
Expand Up @@ -6990,6 +6990,10 @@
"identity": {
"type": "string",
"description": "Optional. The identity of the client who initiated this request."
},
"ignoreMissingTaskQueues": {
"type": "boolean",
"description": "Optional. By default this protects against accidentally removing a task queue from the current ramping version.\nIf false, one of the following conditions must hold true for the new version to be set as ramping version:\n- The new ramping version must have all the task-queues that are present in the existing ramping version.\nor\n- If the new ramping version is missing task queues that are present in the existing ramping version, \n each missing task queue should have either:\n - A current deployment version set, signifying that the task queue has been added to another deployment.\n - An add_rate of 0, signifying that there are no backlogged tasks being added in these queues. (see TaskQueueStats.tasks_add_rate)\nIf true, this operation will succeed even if the new ramping version does not have all the task-queues that were\npresent in the existing ramping version.\nNote: This flag will only be applicable if the version is being set as the ramping version for the first time, signifying\nthat these checks will be ignored when the ramping version is being unset or on just a percentage change."
}
},
"description": "Set/unset the Ramping Version of a Worker Deployment and its ramp percentage."
Expand Down
3 changes: 3 additions & 0 deletions openapi/openapiv3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9739,6 +9739,9 @@ components:
identity:
type: string
description: Optional. The identity of the client who initiated this request.
ignoreMissingTaskQueues:
type: boolean
description: "Optional. By default this protects against accidentally removing a task queue from the current ramping version.\n If false, one of the following conditions must hold true for the new version to be set as ramping version:\n - The new ramping version must have all the task-queues that are present in the existing ramping version.\n or\n - If the new ramping version is missing task queues that are present in the existing ramping version, \n each missing task queue should have either:\n - A current deployment version set, signifying that the task queue has been added to another deployment.\n - An add_rate of 0, signifying that there are no backlogged tasks being added in these queues. (see TaskQueueStats.tasks_add_rate)\n If true, this operation will succeed even if the new ramping version does not have all the task-queues that were\n present in the existing ramping version.\n Note: This flag will only be applicable if the version is being set as the ramping version for the first time, signifying\n that these checks will be ignored when the ramping version is being unset or on just a percentage change."
description: Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.
SetWorkerDeploymentRampingVersionResponse:
type: object
Expand Down
13 changes: 13 additions & 0 deletions temporal/api/workflowservice/v1/request_response.proto
Original file line number Diff line number Diff line change
Expand Up @@ -2060,6 +2060,19 @@ message SetWorkerDeploymentRampingVersionRequest {
bytes conflict_token = 5;
// Optional. The identity of the client who initiated this request.
string identity = 6;
// Optional. By default this protects against accidentally removing a task queue from the current ramping version.
// If false, one of the following conditions must hold true for the new version to be set as ramping version:
// - The new ramping version must have all the task-queues that are present in the existing ramping version.
// or
// - If the new ramping version is missing task queues that are present in the existing ramping version,
// each missing task queue should have either:
// - A current deployment version set, signifying that the task queue has been added to another deployment.
// - An add_rate of 0, signifying that there are no backlogged tasks being added in these queues. (see TaskQueueStats.tasks_add_rate)
// If true, this operation will succeed even if the new ramping version does not have all the task-queues that were
// present in the existing ramping version.
// Note: This flag will only be applicable if the version is being set as the ramping version for the first time, signifying
// that these checks will be ignored when the ramping version is being unset or on just a percentage change.
bool ignore_missing_task_queues = 7;
}

message SetWorkerDeploymentRampingVersionResponse {
Expand Down
Loading