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
update documentation to reflect connectionRef and mutualTLSSecretRef changes in #136 (#154)
<!--- Note to EXTERNAL Contributors -->
<!-- Thanks for opening a PR!
If it is a significant code change, please **make sure there is an open
issue** for this.
We work best with you when we have accepted the idea first before you
code. -->
<!--- For ALL Contributors 👇 -->
## What was changed
updated documentation to reflect connectionRef and mutualTLSSecretRef
changes in #136
## Why?
The current documentation is outdated
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
@@ -87,7 +87,7 @@ Gradually increases the percentage of new workflow executions routed to the new
87
87
88
88
### Worker Options
89
89
Configuration that tells the controller how to connect to the same Temporal cluster and namespace that the worker is connected to:
90
-
-**connection**: Reference to a `TemporalConnection` custom resource
90
+
-**connectionRef**: A reference to a `TemporalConnection` custom resource. This object contains a `name` field to specify the `TemporalConnection` resource.
91
91
-**temporalNamespace**: The Temporal namespace to connect to
92
92
-**deploymentName**: The logical deployment name in Temporal (auto-generated if not specified)
Copy file name to clipboardExpand all lines: docs/migration-guide.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,8 @@ metadata:
92
92
spec:
93
93
replicas: 3
94
94
workerOptions:
95
-
connection: production-temporal
95
+
connectionRef:
96
+
name: production-temporal
96
97
temporalNamespace: production
97
98
rollout:
98
99
strategy: Progressive # Gradual rollout of new versions
@@ -190,7 +191,8 @@ metadata:
190
191
namespace: default
191
192
spec:
192
193
hostPort: "production.abc123.tmprl.cloud:7233"
193
-
mutualTLSSecret: temporal-cloud-mtls # If using mTLS
194
+
mutualTLSSecretRef:
195
+
name: temporal-cloud-mtls # Optional: for mTLS
194
196
---
195
197
apiVersion: temporal.io/v1alpha1
196
198
kind: TemporalConnection
@@ -199,7 +201,8 @@ metadata:
199
201
namespace: default
200
202
spec:
201
203
hostPort: "staging.abc123.tmprl.cloud:7233"
202
-
mutualTLSSecret: temporal-cloud-mtls
204
+
mutualTLSSecretRef:
205
+
name: temporal-cloud-mtls
203
206
```
204
207
205
208
### Step 3: Prepare Your Worker Code
@@ -267,7 +270,8 @@ metadata:
267
270
spec:
268
271
replicas: 3
269
272
workerOptions:
270
-
connection: production-temporal
273
+
connectionRef:
274
+
name: production-temporal
271
275
temporalNamespace: production
272
276
# Start with Progressive strategy using conservative ramp percentages
273
277
rollout:
@@ -674,4 +678,4 @@ See the [Concepts](concepts.md) document for detailed explanations of the resour
674
678
675
679
This approach ensures a safe transition from unversioned to versioned workflows without disrupting running workflows or introducing deployment risks.
676
680
677
-
The Temporal Worker Controller should significantly improve your deployment safety and reduce the risk of workflow disruptions while providing automated rollout capabilities that weren't possible with unversioned workflows.
681
+
The Temporal Worker Controller should significantly improve your deployment safety and reduce the risk of workflow disruptions while providing automated rollout capabilities that weren't possible with unversioned workflows.
0 commit comments