Image Tag Validation

[utieyin]

What happened?

This is a feature of the chart
Currently the chart expects all images to have a v prefix. In our case, we do not tag images with a prefix, just the version number 25.1.4 etc. This obviously breaks our deployment without a patch.

What did you expect to happen?

Either make the v-prefix optional when tag is not empty, add a key for a full image path or a digest key that can be used to compute the full image path.

How can we reproduce it (as minimally and precisely as possible)?. Please include values file.

Details

$ helm install redpanda redpanda/redpanda --set image.tag=25.1.4 --dry-run=client
Error: INSTALLATION FAILED: execution error at (redpanda/templates/_helpers.tpl:64:10): image.tag must start with a 'v' and be a valid semver

Anything else we need to know?

I can create a PR if this suggestion sounds good

Which are the affected charts?

Redpanda

Chart Version(s)

Details

$ helm -n <redpanda-release-namespace> list 
# paste output here

Cloud provider

Details

JIRA Link: K8S-657

[developer-guy]

that'd be awesome if you could support this, thanks @utieyin for creating this issue!

[david-yu]

We're open to contributions if you're able to share a PR that we could perhaps incorporate.

[utieyin]

Thanks @david-yu , will try to put something together and share here

[utieyin]

I have created this PR #1693. Let me know what you think.

[chrisseto]

I thought we had fixed this but the validation was happening in two places and we missed this one as we generally don't test against redpanda SHA's. I do agree this is an issue that should be fixed.

Thank you for the PR @utieyin. However the files in this repository are generated artifacts from the redpanda operator repo. There's a header in each file but it could certainly be more explicit / helpful. We're still piggy backing on the release tooling in this repository but we should update the README's to be more clearly call this out.

I'll patch the issue in the operator repo and get it into the next set of releases!

[utieyin]

However the files in this repository are generated artifacts from the redpanda operator repo.

Thanks @chrisseto I was wondering about that as well. Looking forward to the next chart release! Should I close my PR then?

[chrisseto]

Thanks @chrisseto I was wondering about that as well. Looking forward to the next chart release! Should I close my PR then?

Please and thank you!

I also just realized it's possible to work around this issue in any version of the chart that supports statefulset.podTemplate. It's a bit nasty but it will work if you need an answer today:

statefulset:
  podTemplate:
    spec:
      initContainers:
      - name: tuning
         image: redpandadata/redpanda@sha256:95182a95a80f187a99cfe9fa03aaf18da0a3809a6741a229572f7ec33e795c13
      containers:
      - name: redpanda
        image: redpandadata/redpanda@sha256:95182a95a80f187a99cfe9fa03aaf18da0a3809a6741a229572f7ec33e795c13

We use the image tag in a couple different places. If you need those images to also be SHA256 digests, they can be overriden in the exact same way.

For images other than redpanda (e.g. the operator sidecar) you can set those with some hackery. Though there are some versions of the chart that use the JSON schema to validate that tag is a semver, so YMMV.

statefulset:
  sideCars:
    image:
      repository: redpandadata/redpanda-operator@sha256
      tag: 95182a95a80f187a99cfe9fa03aaf18da0a3809a6741a229572f7ec33e795c13

The actual fix is a bit more involved than I was expected but it will change the chart to support setting tag's to the digest. e.g. sha256:95182a95a80f187a99cfe9fa03aaf18da0a3809a6741a229572f7ec33e795c13