Tzu-Hua Lan created YUNIKORN-2843:
-------------------------------------
Summary: Replace misleading latest tag in Helm chart
Key: YUNIKORN-2843
URL: https://issues.apache.org/jira/browse/YUNIKORN-2843
Project: Apache YuniKorn
Issue Type: Improvement
Components: helm chart
Reporter: Tzu-Hua Lan
h1. Description
This proposal aims to reduce friction during installation for new developers.
Currently, when new developers clone the yunikorn-release repository and
attempt to `helm install` the charts in `/helm-charts/yunikorn`, they encounter
an issue due to the non-existent `latest` tag specified in `values.yaml`.
This misleading configuration could potentially cause confusion and waste time
for newcomers trying to troubleshoot the problem.
h2. Proposal Option 1: Add NOTES.txt and Use Version Placeholder
# Add NOTES.txt:
{code:java}
YuniKorn components installed with the following image tags:
- Scheduler: {{ .Values.image.tag }}
- Scheduler Plugin: {{ .Values.pluginImage.tag }}
- Admission Controller: {{ .Values.admissionController.image.tag }}
- Web UI: {{ .Values.web.image.tag }} {code}
# Change default tag value in values.yaml:
From:
{code:java}
image:
repository: apache/yunikorn
tag: scheduler-latest
pullPolicy: Always{code}
To:
{code:java}
image:
repository: apache/yunikorn
tag: scheduler-{version}
pullPolicy: Always {code}
h3. Benefits:
First-time users will immediately see the installed tags during `helm install`.
Users without a specified tag will be prompted to adjust the `\{version}` when
they see log messages like:
{code:java}
YuniKorn components installed with the following image tags:
- Scheduler: scheduler-{version}
- Scheduler Plugin: scheduler-plugin-{version}
- Admission Controller: admission-{version}
- Web UI: web-{version} {code}
h2. Proposal Option 2: Use Latest Stable Version as Default
Change default tag value in values.yaml:
From:
{code:java}
image:
repository: apache/yunikorn
tag: scheduler-latest
pullPolicy: Always {code}
To:
{code:java}
image:
repository: apache/yunikorn
tag: scheduler-1.5.2
pullPolicy: Always {code}
h3. Benefits:
Ensures a working default configuration out-of-the-box.
h3. Drawbacks:
Requires regular updates to the default tag in the Helm chart to keep it
current.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
