Skip to content

Commit 2cb15e5

Browse files
committed
replace TemporalConnection and TemporalWorkerDeployment in docs and comments
1 parent 889261a commit 2cb15e5

11 files changed

Lines changed: 40 additions & 40 deletions

File tree

docs/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A logical grouping in Temporal that represents a collection of workers that are
1616
### `WorkerDeployment` CRD
1717
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.
1818

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`
2020
> resources can be created, and existing ones must be migrated to `WorkerDeployment`. See the [CRD rename migration guide](migration-crd-rename.md).
2121
> The old `TemporalWorkerDeployment` CRD will be removed in a future release.
2222

docs/crd-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,6 @@ helm install temporal-worker-controller-crds \
152152

153153
After this migration, follow the standard upgrade and rollback instructions above for all future releases.
154154

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)
156156

157157
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).

docs/migration-crd-rename.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CRD Rename Migration Guide
22

3-
Starting with Chart Version v0.27.0 (App Version v1.7.0), the Temporal Worker Controller renames its two primary CRDs and one field reference:
3+
Starting with Chart Version v0.26.0 (App Version v1.7.0), the Temporal Worker Controller renames its two primary CRDs and one field reference:
44

55
| Old name | New name |
66
|---|---|
@@ -24,7 +24,7 @@ After this release, the Worker Controller will be Generally Available (GA), whic
2424
```bash
2525
helm upgrade temporal-worker-controller-crds \
2626
oci://docker.io/temporalio/temporal-worker-controller-crds \
27-
--version <new-version> \
27+
--version 0.26.0 \
2828
--namespace temporal-system
2929
```
3030

@@ -35,7 +35,7 @@ This installs the new `WorkerDeployment` and `Connection` CRDs and marks the old
3535
```bash
3636
helm upgrade temporal-worker-controller \
3737
oci://docker.io/temporalio/temporal-worker-controller \
38-
--version <new-version> \
38+
--version 0.26.0 \
3939
--namespace temporal-system
4040
```
4141

docs/migration-to-unversioned.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This guide walks you through reverting from versioned workers to unversioned wor
66

77
## Important Note
88

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.
1010

1111
## Table of Contents
1212

@@ -66,7 +66,7 @@ worker := worker.New(client, "my-task-queue", worker.Options{})
6666

6767
### Step 2: Deploy the Unversioned Worker
6868

69-
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>)
7070

7171
### Step 3: Set Current Version to Unversioned
7272

docs/migration-to-versioned.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide helps teams migrate from unversioned Temporal workflows to versioned
44

55
## Important Note
66

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.
88

99
## Table of Contents
1010

@@ -86,7 +86,7 @@ spec:
8686
```yaml
8787
# Single Custom Resource manages multiple versions of a worker deployment automatically
8888
apiVersion: temporal.io/v1alpha1
89-
kind: TemporalWorkerDeployment
89+
kind: WorkerDeployment
9090
metadata:
9191
name: my-worker
9292
spec:
@@ -116,7 +116,7 @@ spec:
116116

117117
**New Deployment Process:**
118118
1. Build new worker image
119-
2. Update `TemporalWorkerDeployment` custom resource with new image
119+
2. Update `WorkerDeployment` custom resource with new image
120120
3. Controller creates new Kubernetes `Deployment` for the new version
121121
4. Controller gradually routes new workflows and existing AutoUpgrade workflows to new version
122122
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
152152

153153
#### Phase 2: Initial Migration
154154
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)
156156
3. **Validate controller management** works correctly
157157
4. **Update deployment pipeline** for this worker
158158

@@ -179,13 +179,13 @@ helm install -n temporal-system --create-namespace \
179179

180180
```
181181

182-
### Step 2: Create TemporalConnection Resources
182+
### Step 2: Create Connection Resources
183183

184184
Define connection parameters to your Temporal server(s):
185185

186186
```yaml
187187
apiVersion: temporal.io/v1alpha1
188-
kind: TemporalConnection
188+
kind: Connection
189189
metadata:
190190
name: production-temporal
191191
namespace: default
@@ -195,7 +195,7 @@ spec:
195195
name: temporal-cloud-mtls # Optional: for mTLS
196196
---
197197
apiVersion: temporal.io/v1alpha1
198-
kind: TemporalConnection
198+
kind: Connection
199199
metadata:
200200
name: staging-temporal
201201
namespace: default
@@ -235,9 +235,9 @@ workerOptions.DeploymentOptions = worker.DeploymentOptions{
235235
worker := worker.New(client, "my-task-queue", workerOptions)
236236
```
237237

238-
### Step 4: Create Your First TemporalWorkerDeployment
238+
### Step 4: Create Your First WorkerDeployment
239239

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:
241241

242242
**Existing Unversioned Deployment:**
243243
```yaml
@@ -259,10 +259,10 @@ spec:
259259
value: "production"
260260
```
261261
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):**
263263
```yaml
264264
apiVersion: temporal.io/v1alpha1
265-
kind: TemporalWorkerDeployment
265+
kind: WorkerDeployment
266266
metadata:
267267
name: payment-processor
268268
labels:
@@ -298,9 +298,9 @@ spec:
298298
# Note: Controller automatically adds TEMPORAL_* env vars
299299
```
300300

301-
### Step 5: Deploy the TemporalWorkerDeployment
301+
### Step 5: Deploy the WorkerDeployment
302302

303-
1. **Create the `TemporalWorkerDeployment` custom resource:**
303+
1. **Create the `WorkerDeployment` custom resource:**
304304
```bash
305305
kubectl apply -f payment-processor-versioned.yaml
306306
```
@@ -373,7 +373,7 @@ Now you need to carefully transition from your old unversioned deployment to the
373373
Once the initial migration is complete and validated, you can optimize rollout settings for faster deployments:
374374

375375
```bash
376-
# Update the TemporalWorkerDeployment custom resource to use faster Progressive rollout
376+
# Update the WorkerDeployment custom resource to use faster Progressive rollout
377377
kubectl patch temporalworkerdeployment payment-processor --type='merge' -p='{
378378
"spec": {
379379
"rollout": {
@@ -399,7 +399,7 @@ kubectl set image deployment/payment-processor worker=payment-processor:v1.6.0
399399

400400
**After (Versioned):**
401401
```bash
402-
# New pipeline updates TemporalWorkerDeployment custom resource
402+
# New pipeline updates WorkerDeployment custom resource
403403
kubectl patch temporalworkerdeployment payment-processor --type='merge' -p='{"spec":{"template":{"spec":{"containers":[{"name":"worker","image":"payment-processor:v1.6.0"}]}}}}'
404404
```
405405

@@ -416,7 +416,7 @@ Deploy a new version to validate the entire flow:
416416

417417
1. **Make a small, safe change** to your worker code
418418
2. **Build and push** a new container image
419-
3. **Update the TemporalWorkerDeployment:**
419+
3. **Update the WorkerDeployment:**
420420
```bash
421421
kubectl patch temporalworkerdeployment payment-processor --type='merge' -p='{"spec":{"template":{"spec":{"containers":[{"name":"worker","image":"payment-processor:v1.6.0"}]}}}}'
422422
```
@@ -449,7 +449,7 @@ See [Configuration Reference](configuration.md) for detailed examples and advanc
449449

450450
1. **Test in non-production environment:**
451451
```bash
452-
# Create test TemporalWorkerDeployment
452+
# Create test WorkerDeployment
453453
kubectl apply -f test-worker.yaml
454454

455455
# Verify worker registration
@@ -470,7 +470,7 @@ See [Configuration Reference](configuration.md) for detailed examples and advanc
470470

471471
2. **Monitor version transitions:**
472472
```bash
473-
kubectl get events --field-selector involvedObject.kind=TemporalWorkerDeployment
473+
kubectl get events --field-selector involvedObject.kind=WorkerDeployment
474474
```
475475

476476
3. **Validate workflow routing:**
@@ -489,7 +489,7 @@ If you have multiple services with their own workers, and each service is versio
489489
```yaml
490490
# Payment service worker
491491
apiVersion: temporal.io/v1alpha1
492-
kind: TemporalWorkerDeployment
492+
kind: WorkerDeployment
493493
metadata:
494494
name: payment-processor
495495
namespace: payments
@@ -508,7 +508,7 @@ spec:
508508
---
509509
# Notification service worker (separate service, different risk profile)
510510
apiVersion: temporal.io/v1alpha1
511-
kind: TemporalWorkerDeployment
511+
kind: WorkerDeployment
512512
metadata:
513513
name: notification-sender
514514
namespace: notifications
@@ -528,7 +528,7 @@ Use different rollout strategies based on environment risk:
528528
```yaml
529529
# Production - Conservative rollout
530530
apiVersion: temporal.io/v1alpha1
531-
kind: TemporalWorkerDeployment
531+
kind: WorkerDeployment
532532
metadata:
533533
name: order-processor
534534
namespace: production
@@ -563,7 +563,7 @@ spec:
563563
---
564564
# Staging - Fast rollout for testing
565565
apiVersion: temporal.io/v1alpha1
566-
kind: TemporalWorkerDeployment
566+
kind: WorkerDeployment
567567
metadata:
568568
name: order-processor
569569
namespace: staging
@@ -609,7 +609,7 @@ status:
609609
610610
*Solutions:*
611611
- Check worker logs for connection/initialization errors
612-
- Verify TemporalConnection configuration
612+
- Verify Connection configuration
613613
- Ensure TLS secrets are properly configured
614614
- Verify network connectivity to Temporal server
615615
- Check that worker code properly handles `TEMPORAL_DEPLOYMENT_NAME` and `TEMPORAL_WORKER_BUILD_ID` environment variables
@@ -670,13 +670,13 @@ kubectl get deployments -l temporal.io/managed-by=temporal-worker-controller
670670
kubectl logs -l temporal.io/worker-deployment=my-worker
671671
672672
# Check controller events
673-
kubectl get events --field-selector involvedObject.kind=TemporalWorkerDeployment
673+
kubectl get events --field-selector involvedObject.kind=WorkerDeployment
674674
```
675675

676676
### Getting Help
677677

678678
1. **Check controller logs** for error messages
679-
2. **Review TemporalWorkerDeployment status** for detailed state information
679+
2. **Review WorkerDeployment status** for detailed state information
680680
3. **Verify Temporal server connectivity** from worker pods
681681
4. **File issues** at the project repository with logs and configuration
682682

examples/wrt-hpa-slot-utilization.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WorkerResourceTemplate — per-version HPA scaling on slot utilization (Phase 1)
22
#
33
# This example attaches an HPA to each active versioned Deployment of the
4-
# "helloworld" TemporalWorkerDeployment. The HPA scales on temporal_slot_utilization,
4+
# "helloworld" WorkerDeployment. The HPA scales on temporal_slot_utilization,
55
# a custom metric computed from the Temporal Go SDK's worker task slot gauges by a
66
# Prometheus recording rule.
77
#

examples/wrt-hpa.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# WorkerResourceTemplate — HPA example
22
#
33
# This example attaches a HorizontalPodAutoscaler to each active versioned Deployment
4-
# of the "helloworld" TemporalWorkerDeployment (from the local demo).
4+
# of the "helloworld" WorkerDeployment (from the local demo).
55
#
66
# Prerequisites:
77
# - The helloworld demo is running (skaffold run --profile helloworld-worker)
@@ -20,11 +20,11 @@ apiVersion: temporal.io/v1alpha1
2020
kind: WorkerResourceTemplate
2121
metadata:
2222
name: helloworld-hpa
23-
# Deploy into the same namespace as the helloworld TemporalWorkerDeployment.
23+
# Deploy into the same namespace as the helloworld WorkerDeployment.
2424
# The default Skaffold setup does not set a namespace, so resources land in "default".
2525
namespace: default
2626
spec:
27-
# Must match the name of the TemporalWorkerDeployment.
27+
# Must match the name of the WorkerDeployment.
2828
temporalWorkerDeploymentRef:
2929
name: helloworld
3030

hack/watch_worker_status.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ cwatch() {
1919
done;
2020
}
2121

22-
cwatch "kubectl get -o jsonpath=\"{.status}\" temporalworkerdeployment $1 | yq -p json -o yaml | grep -v -E 'apiVersion|resourceVersion|kind|uid|namespace|deployment|name|versionConflictToken|healthySince' | bat -l yaml --color always --plain --wrap never --theme gruvbox-dark"
22+
cwatch "kubectl get -o jsonpath=\"{.status}\" workerdeployment $1 | yq -p json -o yaml | grep -v -E 'apiVersion|resourceVersion|kind|uid|namespace|deployment|name|versionConflictToken|healthySince' | bat -l yaml --color always --plain --wrap never --theme gruvbox-dark"

helm/temporal-worker-controller/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ namespace:
8585
create: false
8686

8787
webhook:
88-
# enabled controls the optional TemporalWorkerDeployment validating webhook.
88+
# enabled controls the optional WorkerDeployment validating webhook.
8989
# The WorkerResourceTemplate validating webhook is always enabled and does
9090
# not require this flag.
9191
enabled: false

internal/controller/worker_controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const (
4848
// wrtWorkerRefKey is the field index key for WorkerResourceTemplate by effective workerDeploymentRef name.
4949
wrtWorkerRefKey = ".spec.workerDeploymentRef.name"
5050

51-
// finalizerName is the finalizer added to TemporalWorkerDeployment and TemporalConnection
51+
// finalizerName is the finalizer added to deprecated TemporalWorkerDeployment and TemporalConnection
5252
// resources to prevent deletion before cleanup actions are taken. On TWD resources, it
5353
// ensures Temporal server-side versioning data is cleaned up. On TemporalConnection
5454
// resources, it prevents deletion while any TWD still references the connection.

0 commit comments

Comments
 (0)