Reloader icon indicating copy to clipboard operation
Reloader copied to clipboard

[ENHANCE] Improve the "rollout-strategy" annotation documentation

Open lexandrop opened this issue 8 months ago • 3 comments

Is your feature request related to a problem? Please describe. Currently, the README contains this section: Usage - 4. Workload-Specific Rollout Strategy To me personally, it appears to refer to a general "rollout" mechanism in Kubernetes - such as kubectl rollout ...

However, after checking the code, if I'm not mistaken - the annotation has any effect only if Argocd Rollouts (argo website) is being used - https://github.com/stakater/Reloader/blob/chart-v2.1.3/internal/pkg/callbacks/rolling_upgrade.go#L409-L412

Describe the solution you'd like I'd like the docs to clearly state that this option is specific to Argocd Rollouts, not Kubernetes rollouts in general. This would help prevent confusion and ensure users don’t mistakenly assume it's relevant to their workflows if they're not using Argo Rollouts.

lexandrop avatar Jun 02 '25 08:06 lexandrop

As another (potential) user, thank you for pointing this out.

So this means for non-argocd setup the default is always going to trigger a standard k8s rollout restart as per https://github.com/stakater/Reloader/blob/chart-v2.1.3/README.md#reload-strategies ?

ammgws avatar Jun 10 '25 07:06 ammgws

Thanks for your input! The documentation is indeed confusing, we will look into it.

Felix-Stakater avatar Jun 13 '25 09:06 Felix-Stakater

In my case with no ArgoCD in use, when Reloader adds its reloader.stakater.com/last-reloaded-from annotation to the pod template in a StatefulSet, the rollout does actually happen, the pods are recreated one by one.

macrokernel avatar Jul 18 '25 11:07 macrokernel