Confusing placeholder for version when uninstalling the swf operator about incubator-kie-kogito-docs

[MarianMacik]

@gabriel-farache There are 2 options.
What we are suggesting in the documentation is to replace the <version> placeholder with the major and minor version obtained from the image version, e.g. if the image version is 1.41.0, you just take major and minor, which is 1.41. That will translate into 1.41.x in the URL. 1.41.x is our branch, from which every 1.41.x release is being made, so 1.41.0, 1.41.1 etc. This branch will have the latest 1.41.x release set as the image version. So if a newer version is released, that URL will have the image version updated to the latest 1.41.x version.

You found another possibility, not present in the documentation, which is to take the release tag, which have form of v<version> where <version> corresponds directly to the exact image version, e.g. 1.41.0, 1.41.1 etc. So if you take URL with v1.44.1, the image obtained from that operator.yaml will always have the exact same version, even if a 1.44.2 is released.

I hope it is clearer now.

[ricardozanini]

Hey @gabriel-farache you're correct! Do you mind sending a PR? 🙏

[gabriel-farache]

@ricardozanini sure thing, I'll do it on monday

[MarianMacik]

@gabriel-farache Just to clarify, the documentation is correct.

Notice the .x in the <version>.x.

Then
kubectl delete -f https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/<version>.x/operator.yaml
means
kubectl delete -f https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/1.43.x/operator.yaml
which indeed exists.

The change you are suggesting is to reference a release tag, which has the format v1.43.0, which may be probably better as it references a stable release rather than a snapshot version.

Wdyt @ricardozanini ?

[gabriel-farache]

@MarianMacik Well, then this

The operator manager image reflects the current operator’s version. Replace the major and minor version names in the command below. For example, if the image version is 1.41.0 use 1.41

is still confusing: if the image version is 1.41.0 why should the user use 1.41; why remove the number matching the .x?

[MarianMacik]

@gabriel-farache Because this is how the branches are named, 1.41.x, 1.42.x etc. What you are replacing is a placeholder <version> in that string, nothing else.

[gabriel-farache]

@MarianMacik So the version displayed by

kubectl get deployment sonataflow-operator-controller-manager -n sonataflow-operator-system -o jsonpath="{.spec.template.spec.containers[?(@.name=='manager')].image}"
quay.io/kiegroup/kogito-serverless-operator-nightly:1.41.0

Is not correlated with the branch name? If I take the operator from https://raw.githubusercontent.com/kiegroup/kogito-serverless-operator/v1.44.1/operator.yaml the version displayed by the above command would be 1.44.0?

Just trying to understand here

[ricardozanini]

@gabriel-farache feel free to propose a change to the writing to make it clearer, but I agree with @MarianMacik. Nice catch, by the way, Marian! Thank you! 🙏