feat: Add PodPriorityClassName to SubmitOpts. Fixes #7059 (#7274)

Signed-off-by: Nico Mandery <nico@nmandery.net>
argoproj · Nov 30, 2021 · 77f5209 · 77f5209
1 parent 88cbea3
commit 77f5209
Show file tree

Hide file tree

Showing 17 changed files with 647 additions and 567 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -6146,7 +6146,7 @@
           "description": "Backoff is a backoff strategy"
         },
         "expression": {
-          "description": "Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored/",
+          "description": "Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored",
           "type": "string"
         },
         "limit": {
@@ -6550,6 +6550,10 @@
           },
           "type": "array"
         },
+        "podPriorityClassName": {
+          "description": "Set the podPriorityClassName of the workflow",
+          "type": "string"
+        },
         "serverDryRun": {
           "description": "ServerDryRun validates the workflow on the server-side without creating it",
           "type": "boolean"

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -10409,7 +10409,7 @@
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Backoff"
         },
         "expression": {
-          "description": "Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored/",
+          "description": "Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored",
           "type": "string"
         },
         "limit": {
@@ -10813,6 +10813,10 @@
             "type": "string"
           }
         },
+        "podPriorityClassName": {
+          "description": "Set the podPriorityClassName of the workflow",
+          "type": "string"
+        },
         "serverDryRun": {
           "description": "ServerDryRun validates the workflow on the server-side without creating it",
           "type": "boolean"

diff --git a/docs/fields.md b/docs/fields.md
@@ -1868,7 +1868,7 @@ RetryStrategy provides controls on how to retry a workflow step
 |:----------:|:----------:|---------------|
 |`affinity`|[`RetryAffinity`](#retryaffinity)|Affinity prevents running workflow's step on the same host|
 |`backoff`|[`Backoff`](#backoff)|Backoff is a backoff strategy|
-|`expression`|`string`|Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored/|
+|`expression`|`string`|Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored|
 |`limit`|[`IntOrString`](#intorstring)|Limit is the maximum number of attempts when retrying a container|
 |`retryPolicy`|`string`|RetryPolicy is a policy of NodePhase statuses that will be retried|
 

diff --git a/pkg/apis/workflow/v1alpha1/common.go b/pkg/apis/workflow/v1alpha1/common.go
@@ -63,4 +63,6 @@ type SubmitOpts struct {
 	OwnerReference *metav1.OwnerReference `json:"ownerReference,omitempty" protobuf:"bytes,11,opt,name=ownerReference"`
 	// Annotations adds to metadata.labels
 	Annotations string `json:"annotations,omitempty" protobuf:"bytes,12,opt,name=annotations"`
+	// Set the podPriorityClassName of the workflow
+	PodPriorityClassName string `json:"podPriorityClassName,omitempty" protobuf:"bytes,13,opt,name=podPriorityClassName"`
 }
diff --git a/pkg/apis/workflow/v1alpha1/generated.pb.go b/pkg/apis/workflow/v1alpha1/generated.pb.go
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/zz_generated.deepcopy.go b/pkg/apis/workflow/v1alpha1/zz_generated.deepcopy.go
diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1RetryStrategy.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1RetryStrategy.md
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **affinity** | [**IoArgoprojWorkflowV1alpha1RetryAffinity**](IoArgoprojWorkflowV1alpha1RetryAffinity.md) |  |  [optional]
 **backoff** | [**IoArgoprojWorkflowV1alpha1Backoff**](IoArgoprojWorkflowV1alpha1Backoff.md) |  |  [optional]
-**expression** | **String** | Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored/ |  [optional]
+**expression** | **String** | Expression is a condition expression for when a node will be retried. If it evaluates to false, the node will not be retried and the retry strategy will be ignored |  [optional]
 **limit** | **String** |  |  [optional]
 **retryPolicy** | **String** | RetryPolicy is a policy of NodePhase statuses that will be retried |  [optional]
 

diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1SubmitOpts.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1SubmitOpts.md
@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **ownerReference** | [**OwnerReference**](OwnerReference.md) |  |  [optional]
 **parameterFile** | **String** | ParameterFile holds a reference to a parameter file. This option is not supported in API |  [optional]
 **parameters** | **List&lt;String&gt;** | Parameters passes input parameters to workflow |  [optional]
+**podPriorityClassName** | **String** | Set the podPriorityClassName of the workflow |  [optional]
 **serverDryRun** | **Boolean** | ServerDryRun validates the workflow on the server-side without creating it |  [optional]
 **serviceAccount** | **String** | ServiceAccount runs all pods in the workflow using specified ServiceAccount. |  [optional]
 

diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1RetryStrategy.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1RetryStrategy.md
diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1SubmitOpts.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1SubmitOpts.md
diff --git a/sdks/python/client/docs/WorkflowServiceApi.md b/sdks/python/client/docs/WorkflowServiceApi.md
diff --git a/sdks/python/client/openapi_client/model/io_argoproj_workflow_v1alpha1_retry_strategy.py b/sdks/python/client/openapi_client/model/io_argoproj_workflow_v1alpha1_retry_strategy.py
diff --git a/sdks/python/client/openapi_client/model/io_argoproj_workflow_v1alpha1_submit_opts.py b/sdks/python/client/openapi_client/model/io_argoproj_workflow_v1alpha1_submit_opts.py
diff --git a/workflow/util/util.go b/workflow/util/util.go
@@ -236,6 +236,10 @@ func ApplySubmitOpts(wf *wfv1.Workflow, opts *wfv1.SubmitOpts) error {
 	if opts.ServiceAccount != "" {
 		wf.Spec.ServiceAccountName = opts.ServiceAccount
 	}
+	if opts.PodPriorityClassName != "" {
+		wf.Spec.PodPriorityClassName = opts.PodPriorityClassName
+	}
+
 	wfLabels := wf.GetLabels()
 	if wfLabels == nil {
 		wfLabels = make(map[string]string)

diff --git a/workflow/util/util_test.go b/workflow/util/util_test.go
@@ -612,6 +612,12 @@ func TestApplySubmitOpts(t *testing.T) {
 			assert.Equal(t, "81861780812", parameters[0].Value.String())
 		}
 	})
+	t.Run("PodPriorityClassName", func(t *testing.T) {
+		wf := &wfv1.Workflow{}
+		err := ApplySubmitOpts(wf, &wfv1.SubmitOpts{PodPriorityClassName: "abc"})
+		assert.NoError(t, err)
+		assert.Equal(t, "abc", wf.Spec.PodPriorityClassName)
+	})
 }
 
 func TestFormulateResubmitWorkflow(t *testing.T) {