docs: Clarify maxDuration behavior when used with activeDeadlineSecon…

…ds. Fixes #13044 (#13068)
argoproj · May 20, 2024 · 34ab2e3 · 34ab2e3
1 parent a1db80a
commit 34ab2e3
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 13 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/docs/executor_swagger.md b/docs/executor_swagger.md
@@ -463,7 +463,10 @@ the ReadOnly setting in VolumeMounts.
 |------|------|---------|:--------:| ------- |-------------|---------|
 | duration | string| `string` |  | | Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h") |  |
 | factor | [IntOrString](#int-or-string)| `IntOrString` |  | |  |  |
-| maxDuration | string| `string` |  | | MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy |  |
+| maxDuration | string| `string` |  | | MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy.
+It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds.
+However, when the workflow fails, the pod's deadline is then overridden by maxDuration.
+This ensures that the workflow does not exceed the specified maximum duration when retries are involved. |  |
 
 
 

diff --git a/docs/fields.md b/docs/fields.md
@@ -2333,7 +2333,7 @@ Backoff is a backoff strategy to use within retryStrategy
 |:----------:|:----------:|---------------|
 |`duration`|`string`|Duration is the amount to back off. Default unit is seconds, but could also be a duration (e.g. "2m", "1h")|
 |`factor`|[`IntOrString`](#intorstring)|Factor is a factor to multiply the base duration after each failed retry|
-|`maxDuration`|`string`|MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy|
+|`maxDuration`|`string`|MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy. It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds. However, when the workflow fails, the pod's deadline is then overridden by maxDuration. This ensures that the workflow does not exceed the specified maximum duration when retries are involved.|
 
 ## Mutex
 

diff --git a/pkg/apis/workflow/v1alpha1/generated.proto b/pkg/apis/workflow/v1alpha1/generated.proto
diff --git a/pkg/apis/workflow/v1alpha1/openapi_generated.go b/pkg/apis/workflow/v1alpha1/openapi_generated.go
diff --git a/pkg/apis/workflow/v1alpha1/workflow_types.go b/pkg/apis/workflow/v1alpha1/workflow_types.go
@@ -2014,7 +2014,10 @@ type Backoff struct {
 	Duration string `json:"duration,omitempty" protobuf:"varint,1,opt,name=duration"`
 	// Factor is a factor to multiply the base duration after each failed retry
 	Factor *intstr.IntOrString `json:"factor,omitempty" protobuf:"varint,2,opt,name=factor"`
-	// MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy
+	// MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy.
+	// It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds.
+	// However, when the workflow fails, the pod's deadline is then overridden by maxDuration.
+	// This ensures that the workflow does not exceed the specified maximum duration when retries are involved.
 	MaxDuration string `json:"maxDuration,omitempty" protobuf:"varint,3,opt,name=maxDuration"`
 }
 

diff --git a/pkg/plugins/executor/swagger.yml b/pkg/plugins/executor/swagger.yml
@@ -365,8 +365,11 @@ definitions:
       factor:
         $ref: '#/definitions/IntOrString'
       maxDuration:
-        description: MaxDuration is the maximum amount of time allowed for a workflow
-          in the backoff strategy
+        description: |-
+          MaxDuration is the maximum amount of time allowed for a workflow in the backoff strategy.
+          It is important to note that if the workflow template includes activeDeadlineSeconds, the pod's deadline is initially set with activeDeadlineSeconds.
+          However, when the workflow fails, the pod's deadline is then overridden by maxDuration.
+          This ensures that the workflow does not exceed the specified maximum duration when retries are involved.
         type: string
     type: object
   BasicAuth:

diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1Backoff.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1Backoff.md
diff --git a/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_backoff.py b/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_backoff.py
diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1Backoff.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1Backoff.md