helm-charts icon indicating copy to clipboard operation
helm-charts copied to clipboard

Create a unique setup/update Job name per release version

Open jorhett opened this issue 1 month ago • 2 comments

Why?

The helm chart currently creates a job to setup and update the schema named temporal-schema-{{Helm chart version}} since #564 which is often just temporal-schema-1. The lifetime of this chart is 1 day, which has two separate impacts:

  • The chart must be manually deleted before an upgrade can occur
    • #554
    • #735
  • ArgoCD shows OutOfSync / Helm diff after Job expires
    • #636
    • #709
    • #743
  • Instructions say a user must run the upgrade, but the chart does it for you if schema.update is enabled
    • #737

What was changed

  1. Give the schema update job and pod a name including the major-minor version of Temporal. This will allow multiple minor version upgrades to succeed without having to manually remove the job.

  2. Remove the job removal TTL the value of which was debatable, but regardless of value will show sync issues with Helm diff and ArgoCD sync status. As the use of Helm hooks was explicitly removed in #522 to resolve issues with --wait, this provides another way to retain diff/sync. This also means that job update logs are retained and available for life of the helm release.

  3. Updated the README to make it clear the manual update steps aren't required if update is enabled.

Checklist

  1. Closes #554 #735 #636 #709 #737

  2. How was this tested: it's only a name change, helm upgrade did it all 😁

  3. Any docs updates needed?

Updates to the README are included.

jorhett avatar Nov 30 '25 09:11 jorhett

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Nov 30 '25 09:11 CLAassistant

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

CLAassistant avatar Nov 30 '25 09:11 CLAassistant

Please could you update this now that v1 has been merged to master. Please add a test, and consider how this might work given we're currently doing rc releases? Might need to have support for pre/alpha/rc style stuff in the schema job name as well.

robholland avatar Dec 19 '25 11:12 robholland