Skip to content

Commit 14322c6

Browse files
authored
Ownership docs: Update the docs to reflect the right command. (#161)
<!--- 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 - Update the ownership transfer command to now reflect the right command. Previously, it was passing the value for the key `temporal.io/ignore-last-modifier` as the boolean true. - This was wrong because the controller expects the value to be a string. ## Why? - Correctness. ## Checklist <!--- add/delete as needed ---> 1. Closes <!-- add issue number here --> 2. How was this tested: - Wasn't tbh 3. Any docs updates needed? <!--- update README if applicable or point out where to update docs.temporal.io -->
1 parent dc164ca commit 14322c6

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/ownership.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,34 @@ for the Worker Controller to take over, you can update the metadata to indicate
2424
There is no Temporal server support for Worker Deployment Version-level metadata, so you'll have to set this value on
2525
the Current Version of your Worker Deployment.
2626

27+
Note: The controller decodes this metadata value as a string. Be sure to set the value to the string "true" (not the boolean true).
28+
29+
```bash
30+
temporal worker deployment update-metadata-version \
31+
--deployment-name $MY_DEPLOYMENT \
32+
--build-id $CURRENT_VERSION_BUILD_ID \
33+
--metadata 'temporal.io/ignore-last-modifier="true"'
34+
```
35+
Alternatively, if your CLI supports JSON input:
2736
```bash
2837
temporal worker deployment update-metadata-version \
2938
--deployment-name $MY_DEPLOYMENT \
30-
--build-id $CURRENT_VERSION_BUILD_ID
31-
--metadata 'temporal.io/ignore-last-modifier=true'`
39+
--build-id $CURRENT_VERSION_BUILD_ID \
40+
--metadata-json '{"temporal.io/ignore-last-modifier":"true"}'
3241
```
3342
In the rare case that you have a nil Current Version when you are passing back ownership, you should set it on your Ramping Version
3443
```bash
3544
temporal worker deployment update-metadata-version \
3645
--deployment-name $MY_DEPLOYMENT \
37-
--build-id $RAMPING_VERSION_BUILD_ID
38-
--metadata 'temporal.io/ignore-last-modifier=true'`
46+
--build-id $RAMPING_VERSION_BUILD_ID \
47+
--metadata 'temporal.io/ignore-last-modifier="true"'
48+
```
49+
Or with JSON:
50+
```bash
51+
temporal worker deployment update-metadata-version \
52+
--deployment-name $MY_DEPLOYMENT \
53+
--build-id $RAMPING_VERSION_BUILD_ID \
54+
--metadata-json '{"temporal.io/ignore-last-modifier":"true"}'
3955
```
4056

4157
In the even rarer case that you have nil Current Version and nil Ramping Version, you'll need to use the CLI or SDK to

0 commit comments

Comments
 (0)