docs: Deprecate PodPriority field in WorkflowSpec (Fixes argoproj#8762)…

… (argoproj#9400) * fix: Deprecate PodPriority field in WorkflowSpec Signed-off-by: Mriyam Tamuli <[email protected]> * Run pre-commit -B make target Signed-off-by: Mriyam Tamuli <[email protected]> Signed-off-by: Mriyam Tamuli <[email protected]> Signed-off-by: juchao <[email protected]>
juchaosong · Nov 3, 2022 · c4e73f5 · c4e73f5
1 parent c7cc9ac
commit c4e73f5
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 8 deletions.
diff --git a/api/jsonschema/schema.json b/api/jsonschema/schema.json
@@ -7177,7 +7177,7 @@
           "description": "PodMetadata defines additional metadata that should be applied to workflow pods"
         },
         "podPriority": {
-          "description": "Priority to apply to workflow pods.",
+          "description": "Priority to apply to workflow pods. DEPRECATED: Use PodPriorityClassName instead.",
           "type": "integer"
         },
         "podPriorityClassName": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -11063,7 +11063,7 @@
           "$ref": "#/definitions/io.argoproj.workflow.v1alpha1.Metadata"
         },
         "podPriority": {
-          "description": "Priority to apply to workflow pods.",
+          "description": "Priority to apply to workflow pods. DEPRECATED: Use PodPriorityClassName instead.",
           "type": "integer"
         },
         "podPriorityClassName": {

diff --git a/docs/fields.md b/docs/fields.md
@@ -807,7 +807,7 @@ WorkflowSpec is the specification of a Workflow.
 |`podDisruptionBudget`|[`PodDisruptionBudgetSpec`](#poddisruptionbudgetspec)|PodDisruptionBudget holds the number of concurrent disruptions that you allow for Workflow's Pods. Controller will automatically add the selector with workflow name, if selector is empty. Optional: Defaults to empty.|
 |`podGC`|[`PodGC`](#podgc)|PodGC describes the strategy to use when deleting completed pods|
 |`podMetadata`|[`Metadata`](#metadata)|PodMetadata defines additional metadata that should be applied to workflow pods|
-|`podPriority`|`integer`|Priority to apply to workflow pods.|
+|~`podPriority`~|~`integer`~|~Priority to apply to workflow pods.~ DEPRECATED: Use PodPriorityClassName instead.|
 |`podPriorityClassName`|`string`|PriorityClassName to apply to workflow pods.|
 |`podSpecPatch`|`string`|PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits).|
 |`priority`|`integer`|Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first.|

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
@@ -387,6 +387,7 @@ type WorkflowSpec struct {
 	PodPriorityClassName string `json:"podPriorityClassName,omitempty" protobuf:"bytes,23,opt,name=podPriorityClassName"`
 
 	// Priority to apply to workflow pods.
+	// DEPRECATED: Use PodPriorityClassName instead.
 	PodPriority *int32 `json:"podPriority,omitempty" protobuf:"bytes,24,opt,name=podPriority"`
 
 	// +patchStrategy=merge

diff --git a/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1WorkflowSpec.md b/sdks/java/client/docs/IoArgoprojWorkflowV1alpha1WorkflowSpec.md
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
 **podDisruptionBudget** | [**IoK8sApiPolicyV1beta1PodDisruptionBudgetSpec**](IoK8sApiPolicyV1beta1PodDisruptionBudgetSpec.md) |  |  [optional]
 **podGC** | [**IoArgoprojWorkflowV1alpha1PodGC**](IoArgoprojWorkflowV1alpha1PodGC.md) |  |  [optional]
 **podMetadata** | [**IoArgoprojWorkflowV1alpha1Metadata**](IoArgoprojWorkflowV1alpha1Metadata.md) |  |  [optional]
-**podPriority** | **Integer** | Priority to apply to workflow pods. |  [optional]
+**podPriority** | **Integer** | Priority to apply to workflow pods. DEPRECATED: Use PodPriorityClassName instead. |  [optional]
 **podPriorityClassName** | **String** | PriorityClassName to apply to workflow pods. |  [optional]
 **podSpecPatch** | **String** | PodSpecPatch holds strategic merge patch to apply against the pod spec. Allows parameterization of container fields which are not strings (e.g. resource limits). |  [optional]
 **priority** | **Integer** | Priority is used if controller is configured to process limited number of workflows in parallel. Workflows with higher priority are processed first. |  [optional]

diff --git a/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_workflow_spec.py b/sdks/python/client/argo_workflows/model/io_argoproj_workflow_v1alpha1_workflow_spec.py
diff --git a/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1WorkflowSpec.md b/sdks/python/client/docs/IoArgoprojWorkflowV1alpha1WorkflowSpec.md