You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/concepts.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ A logical grouping in Temporal that represents a collection of workers that are
16
16
### `WorkerDeployment` CRD
17
17
The Kubernetes Custom Resource Definition that manages one Temporal Worker Deployment. This is the primary resource you interact with when using the Temporal Worker Controller.
18
18
19
-
> **Note:** This CRD was named `TemporalWorkerDeployment` in Chart Version v0.26.0 and earlier. In Chart Version v0.27.0, no new `TemporalWorkerDeployment`
19
+
> **Note:** This CRD was named `TemporalWorkerDeployment` in Chart Version v0.25.0 and earlier. In Chart Version v0.27.0, no new `TemporalWorkerDeployment`
20
20
> resources can be created, and existing ones must be migrated to `WorkerDeployment`. See the [CRD rename migration guide](migration-crd-rename.md).
21
21
> The old `TemporalWorkerDeployment` CRD will be removed in a future release.
After this migration, follow the standard upgrade and rollback instructions above for all future releases.
154
154
155
-
### Migrating from TemporalWorkerDeployment/TemporalConnection CRDs (Chart Version v0.26.0 and earlier)
155
+
### Migrating from TemporalWorkerDeployment/TemporalConnection CRDs (Chart Version v0.25.0 and earlier)
156
156
157
157
See the [CRD rename migration guide](migration-crd-rename.md) for step-by-step instructions to migrate from the old CRD names (`TemporalWorkerDeployment`, `TemporalConnection`) to the new names (`WorkerDeployment`, `Connection`) introduced in Chart Version v0.27.0 (App Version v1.7.0).
Copy file name to clipboardExpand all lines: docs/migration-to-unversioned.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ This guide walks you through reverting from versioned workers to unversioned wor
6
6
7
7
## Important Note
8
8
9
-
This guide uses specific terminology that is defined in the [Concepts](concepts.md) document. Please review the concepts document first to understand key terms like **Temporal Worker Deployment**, **`TemporalWorkerDeployment` CRD**, and **Kubernetes `Deployment`**, as well as the relationship between them.
9
+
This guide uses specific terminology that is defined in the [Concepts](concepts.md) document. Please review the concepts document first to understand key terms like **Worker Deployment**, **`WorkerDeployment` CRD**, and **Kubernetes `Deployment`**, as well as the relationship between them.
Deploy your unversioned workers as you would without the Worker Controller (ie. as their own `Deployments` not connected to a `TemporalWorkerDeployment` resource) and ensure they are polling all of the Task Queues in your Worker Deployment. This can be done by verifying their presence on the Task Queues page (https://cloud.temporal.io/namespaces/<your-namespace>/task-queues/<your-task-queue>)
69
+
Deploy your unversioned workers as you would without the Worker Controller (ie. as their own `Deployments` not connected to a `WorkerDeployment` resource) and ensure they are polling all of the Task Queues in your Worker Deployment. This can be done by verifying their presence on the Task Queues page (https://cloud.temporal.io/namespaces/<your-namespace>/task-queues/<your-task-queue>)
Copy file name to clipboardExpand all lines: docs/migration-to-versioned.md
+25-25Lines changed: 25 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This guide helps teams migrate from unversioned Temporal workflows to versioned
4
4
5
5
## Important Note
6
6
7
-
This guide uses specific terminology that is defined in the [Concepts](concepts.md) document. Please review the concepts document first to understand key terms like **Temporal Worker Deployment**, **`TemporalWorkerDeployment` CRD**, and **Kubernetes `Deployment`**, as well as the relationship between them.
7
+
This guide uses specific terminology that is defined in the [Concepts](concepts.md) document. Please review the concepts document first to understand key terms like **Temporal Worker Deployment**, **`WorkerDeployment` CRD**, and **Kubernetes `Deployment`**, as well as the relationship between them.
8
8
9
9
## Table of Contents
10
10
@@ -86,7 +86,7 @@ spec:
86
86
```yaml
87
87
# Single Custom Resource manages multiple versions of a worker deployment automatically
88
88
apiVersion: temporal.io/v1alpha1
89
-
kind: TemporalWorkerDeployment
89
+
kind: WorkerDeployment
90
90
metadata:
91
91
name: my-worker
92
92
spec:
@@ -116,7 +116,7 @@ spec:
116
116
117
117
**New Deployment Process:**
118
118
1. Build new worker image
119
-
2. Update `TemporalWorkerDeployment` custom resource with new image
119
+
2. Update `WorkerDeployment` custom resource with new image
120
120
3. Controller creates new Kubernetes `Deployment` for the new version
121
121
4. Controller gradually routes new workflows and existing AutoUpgrade workflows to new version
122
122
5. Old version continues handling existing Pinned workflows until they complete
@@ -152,7 +152,7 @@ The migration from unversioned to versioned workflows requires careful planning
152
152
153
153
#### Phase 2: Initial Migration
154
154
1.**Choose lowest-risk worker** to migrate first
155
-
2.**Create `TemporalWorkerDeployment` custom resource** with a Progressive strategy (conservative intervals recommended)
155
+
2.**Create `WorkerDeployment` custom resource** with a Progressive strategy (conservative intervals recommended)
156
156
3.**Validate controller management** works correctly
### Step 4: Create Your First TemporalWorkerDeployment
238
+
### Step 4: Create Your First WorkerDeployment
239
239
240
-
Start with your lowest-risk worker. Make a copy of your existing unversioned Deployment and convert it to a `TemporalWorkerDeployment` custom resource:
240
+
Start with your lowest-risk worker. Make a copy of your existing unversioned Deployment and convert it to a `WorkerDeployment` custom resource:
241
241
242
242
**Existing Unversioned Deployment:**
243
243
```yaml
@@ -259,10 +259,10 @@ spec:
259
259
value: "production"
260
260
```
261
261
262
-
**New TemporalWorkerDeployment custom resource (IMPORTANT: Use Progressive strategy with conservative settings initially):**
262
+
**New WorkerDeployment custom resource (IMPORTANT: Use Progressive strategy with conservative settings initially):**
263
263
```yaml
264
264
apiVersion: temporal.io/v1alpha1
265
-
kind: TemporalWorkerDeployment
265
+
kind: WorkerDeployment
266
266
metadata:
267
267
name: payment-processor
268
268
labels:
@@ -298,9 +298,9 @@ spec:
298
298
# Note: Controller automatically adds TEMPORAL_* env vars
299
299
```
300
300
301
-
### Step 5: Deploy the TemporalWorkerDeployment
301
+
### Step 5: Deploy the WorkerDeployment
302
302
303
-
1.**Create the `TemporalWorkerDeployment` custom resource:**
303
+
1.**Create the `WorkerDeployment` custom resource:**
304
304
```bash
305
305
kubectl apply -f payment-processor-versioned.yaml
306
306
```
@@ -373,7 +373,7 @@ Now you need to carefully transition from your old unversioned deployment to the
373
373
Once the initial migration is complete and validated, you can optimize rollout settings for faster deployments:
374
374
375
375
```bash
376
-
# Update the TemporalWorkerDeployment custom resource to use faster Progressive rollout
376
+
# Update the WorkerDeployment custom resource to use faster Progressive rollout
0 commit comments