Skip to content

Tell the UI it was installed by Helm - #987

Draft
rossnelson wants to merge 7 commits into
mainfrom
rossnelson/ui-distribution-env
Draft

rossnelson wants to merge 7 commits into
mainfrom
rossnelson/ui-distribution-env

Conversation

@rossnelson

Copy link
Copy Markdown

What

Sets TEMPORAL_UI_DISTRIBUTION=helm on the web container.

Why

The UI is growing an upgrade notice that offers a newer version of whatever artifact the user installed. It reads TEMPORAL_UI_DISTRIBUTION to decide which that is.

The chart runs the temporalio/ui image, whose own default for that variable is docker. So without this, a Helm install identifies as a raw Docker install and the notice links operators to Docker Hub instead of to this chart.

Only the distribution name is needed. The notice compares the running UI version, which the UI already knows, so there is nothing version-related to inject here. That is deliberate: the chart version is a poor proxy for the UI version in both directions β€” chart 1.6.0 pinned UI 2.52.0 and 1.7.0 pinned 2.54.1, with seven UI releases published in the two months between them, and operators can override web.image.tag independently anyway.

Not a values entry

This is a fact about how the chart deploys, not an operator preference, so it is hardcoded rather than exposed in values.yaml. Operators who want to silence the notice can already set TEMPORAL_NOTIFY_ON_NEW_VERSION=false through web.additionalEnv, which is how the chart handles the neighbouring UI toggles such as TEMPORAL_DISABLE_NEWS_FETCH.

Draft

The variable does nothing until a UI image ships with the upgrade notice. Holding this as a draft until that lands β€” happy to keep it open as the marker.

Testing

I could not render the chart locally: helm template fails ahead of this template on datastore validation unrelated to the change. The addition is a static entry at the same indentation as the adjacent TEMPORAL_ADDRESS entry in the same env: list, so CI rendering should cover it. Worth a reviewer's eye on that.

The UI reads TEMPORAL_UI_DISTRIBUTION to decide which artifact to point
at when it offers an upgrade. Without it the chart's UI container falls
back to the image default of "docker" and sends operators to Docker Hub
rather than to the chart.
The UI now ships its upgrade notice off, so the chart turns it on for
Helm installs. Reading the flag from values rather than hardcoding it
keeps the daily call to the registry under the operator's control.
The UI now ships its upgrade notice off, so the chart turns it on for
Helm installs. Reading the flag from values rather than hardcoding it
keeps the daily call to the registry under the operator's control.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant