Skip to content

Commit cd22fc6

Browse files
committed
added description for worker deployment versions in encyclopedia
1 parent c5d0c09 commit cd22fc6

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

docs/encyclopedia/workers/worker-versioning.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,12 @@ A **Pinned** Workflow is guaranteed to complete on a single Worker Deployment Ve
4848

4949
An **Auto-Upgrade** Workflow will move to the latest Worker Deployment Version automatically whenever you change the current version. Auto-upgrade Workflows are not restricted to a single Deployment Version and need to be kept replay-safe manually, i.e. with [patching](/workflow-definition#workflow-versioning).
5050

51+
## Versioning Types
52+
53+
- **Current Worker Deployment Version**: the version where Workflows are routed to unless they were previously pinned on a different version. Other versions can continue polling to allow pinned Workflows to finish executing or in case you need to roll back. If no current version is specified, the default is unversioned.
54+
- **Ramping Worker Deployment Version**: the version where a configurable percentage of Workflows are routed to unless they were previously pinned on a different version. The ramp percentage can be in the range [0, 100]. Workflows that don't go to the Ramping Version will go to the Current Version. If no Ramping Version is specified, 100% of new Workflows and Auto-Upgrade Workflows will go to the Current Version.
55+
- **Target Worker Deployment Version**: the version your Workflow will move to next. This could be the Deployment's Current Version or the Ramping Version. For example, if an Auto-Upgrade Workflow was running on Version A, the Current Version is B, and there is a 5% ramp to C, there is a 95% chance that its Target Version is B and 5% that it's C.
56+
5157
## Versioning Statuses {#versioning-statuses}
5258

5359
A Worker Deployment Version moves through the following states:

docs/production-deployment/worker-deployments/worker-versioning.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,11 @@ To get started with Worker Versioning, you should understand some concepts aroun
8181
- Pinned Workflows are designed for use with rainbow deployments. See [Deployment Systems](#deployment-systems).
8282
- Pinned Workflows don't need to be patched, as they run on the same worker and build until they complete.
8383
- If you expect your Workflow to run longer than you want your Worker Deployment Versions to exist, you should mark your Workflow Type as Auto-Upgrade.
84-
- Each Worker Deployment has a single **Current Version** which is where workflows are routed to unless they were previously pinned on a different version. Other versions can continue polling to allow pinned Workflows to finish executing, or in case you need to roll back. If no current version is specified, the default is unversioned.
85-
- Each Worker Deployment can have a **Ramping Version** which is where a configurable percentage of Workflows are routed to unless they were previously pinned on a different version. The ramp percentage can be in the range [0, 100]. Workflows that don't go to the Ramping Version will go to the Current Version. If no Ramping Version is specified, 100% of new Workflows and Auto-Upgrade Workflows will go to the Current Version.
86-
- For a given Workflow, its **Target Worker Deployment Version** is the version it will move to next. This could be the Deployment's Current Version or the Ramping Version. For example, if an Auto-Upgrade Workflow was running on Version A, the Current Version is B, and there is a 5% ramp to C, there is a 95% chance that its Target Version is B and 5% that it's C.
84+
- Each Worker Deployment has a single **Current Version** which is where Workflows are routed to unless they were previously pinned on a different version.
85+
- Each Worker Deployment can have a **Ramping Version** which is where a configurable percentage of Workflows are routed to unless they were previously pinned on a different version.
86+
- For a given Workflow, its **Target Worker Deployment Version** is the version it will move to next.
87+
88+
You can find more details on the versioning types above in the [Worker Versioning encyclopedia article](/worker-versioning#versioning-types).
8789

8890
## Setting up your deployment system {#deployment-systems}
8991

0 commit comments

Comments
 (0)