Skip to content

Commit a2557f9

Browse files
authored
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
1 parent 7884334 commit a2557f9

File tree

3 files changed

+20
-11
lines changed

3 files changed

+20
-11
lines changed

docs/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Gradually increases the percentage of new workflow executions routed to the new
8787

8888
### Worker Options
8989
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.
9191
- **temporalNamespace**: The Temporal namespace to connect to
9292
- **deploymentName**: The logical deployment name in Temporal (auto-generated if not specified)
9393

docs/configuration.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,8 @@ Configure how workers connect to Temporal:
149149
150150
```yaml
151151
workerOptions:
152-
connection: production-temporal # Reference to TemporalConnection
152+
connectionRef:
153+
name: production-temporal # Reference to TemporalConnection
153154
temporalNamespace: production # Temporal namespace
154155
taskQueues: # Optional: explicit task queue list
155156
- order-processing
@@ -167,7 +168,8 @@ metadata:
167168
name: production-temporal
168169
spec:
169170
hostPort: "production.abc123.tmprl.cloud:7233"
170-
mutualTLSSecret: temporal-cloud-mtls # Optional: for mTLS
171+
mutualTLSSecretRef:
172+
name: temporal-cloud-mtls # Optional: for mTLS
171173
```
172174

173175
## Gate Configuration
@@ -198,7 +200,8 @@ metadata:
198200
spec:
199201
replicas: 5
200202
workerOptions:
201-
connection: production-temporal
203+
connectionRef:
204+
name: production-temporal
202205
temporalNamespace: production
203206
rollout:
204207
strategy: Progressive
@@ -226,7 +229,8 @@ metadata:
226229
spec:
227230
replicas: 2
228231
workerOptions:
229-
connection: staging-temporal
232+
connectionRef:
233+
name: staging-temporal
230234
temporalNamespace: staging
231235
rollout:
232236
strategy: Progressive
@@ -246,7 +250,8 @@ Configure workers that handle multiple task queues:
246250

247251
```yaml
248252
workerOptions:
249-
connection: production-temporal
253+
connectionRef:
254+
name: production-temporal
250255
temporalNamespace: production
251256
taskQueues:
252257
- order-processing

docs/migration-guide.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ metadata:
9292
spec:
9393
replicas: 3
9494
workerOptions:
95-
connection: production-temporal
95+
connectionRef:
96+
name: production-temporal
9697
temporalNamespace: production
9798
rollout:
9899
strategy: Progressive # Gradual rollout of new versions
@@ -190,7 +191,8 @@ metadata:
190191
namespace: default
191192
spec:
192193
hostPort: "production.abc123.tmprl.cloud:7233"
193-
mutualTLSSecret: temporal-cloud-mtls # If using mTLS
194+
mutualTLSSecretRef:
195+
name: temporal-cloud-mtls # Optional: for mTLS
194196
---
195197
apiVersion: temporal.io/v1alpha1
196198
kind: TemporalConnection
@@ -199,7 +201,8 @@ metadata:
199201
namespace: default
200202
spec:
201203
hostPort: "staging.abc123.tmprl.cloud:7233"
202-
mutualTLSSecret: temporal-cloud-mtls
204+
mutualTLSSecretRef:
205+
name: temporal-cloud-mtls
203206
```
204207
205208
### Step 3: Prepare Your Worker Code
@@ -267,7 +270,8 @@ metadata:
267270
spec:
268271
replicas: 3
269272
workerOptions:
270-
connection: production-temporal
273+
connectionRef:
274+
name: production-temporal
271275
temporalNamespace: production
272276
# Start with Progressive strategy using conservative ramp percentages
273277
rollout:
@@ -674,4 +678,4 @@ See the [Concepts](concepts.md) document for detailed explanations of the resour
674678

675679
This approach ensures a safe transition from unversioned to versioned workflows without disrupting running workflows or introducing deployment risks.
676680

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

Comments
 (0)