kargo icon indicating copy to clipboard operation
kargo copied to clipboard

Documentation Request: How to configure timeout in the argocd-update step?

Open spines83 opened this issue 8 months ago • 3 comments

In https://docs.kargo.io/user-guide/reference-docs/promotion-steps/argocd-update there is an info block that says

"Additionally, it is recommended that if a promotion process is expected to sometimes encounter an active deny window, the argocd-update step should be configured with a timeout that is at least as long as the longest expected deny window. "

However, there are no references to timeouts on that page outside of that info block.

Further https://docs.kargo.io/user-guide/reference-docs/promotion-templates#step-configuration states "The configuration options available for a step are specific to the step itself" which to me implies that there are not any configurations that are global across promotion steps.

Could you please clarify how this timeout is intended to be set? If there are configurations that are applied regardless of step, perhaps a broader request would be to have those documented on the Promotion Steps page (https://docs.kargo.io/user-guide/reference-docs/promotion-steps/)

Thank you!

spines83 avatar Apr 24 '25 18:04 spines83

Timeouts are part of the "retry configuration", see: https://docs.kargo.io/user-guide/reference-docs/promotion-templates/#step-retries

hiddeco avatar Apr 24 '25 18:04 hiddeco

Thanks Hidde! I gave that a spin and it worked.

I did see that while browsing through posts/issues, but my confusion was mostly tied to that retry configuration stating "System-wide, the default error threshold is 1 and the default timeout is indefinite" and then the argocd-update step stating "the argocd-update step should be configured with a timeout....(The step's default timeout is five minutes.)" -- I interpreted that as two separate configurations.

It would have been easier to discover/confirm that configuration if that info block linked to the retry configuration you posted in the docs. Feel free to close this and thanks again =)

spines83 avatar Apr 25 '25 13:04 spines83

Ya... there ought to be a link from that suggestion to the docs about retries/timeouts.

To clarify defaults:

  1. There are system-level default timeouts.
  2. A step runner (the logic that executes a step) can override system-level defaults.
  3. A user's own step configuration can override both of the above.

So precedence is 3, 2, 1.

krancour avatar Apr 25 '25 19:04 krancour