feat: controller-wide pipeline templates. Closes numaproj#305

Signed-off-by: David Seapy <[email protected]>
dseapy · Nov 4, 2022 · 219470a · 219470a
1 parent bfab8f1
commit 219470a
Show file tree

Hide file tree

Showing 19 changed files with 3,617 additions and 381 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -18788,6 +18788,10 @@
         "job": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.JobTemplate",
           "description": "JobTemplate is used to customize Jobs"
+        },
+        "vertex": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexTemplate",
+          "description": "VertexTemplate is used to customize Vertices"
         }
       },
       "type": "object"
@@ -19054,6 +19058,65 @@
       ],
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.VertexTemplate": {
+      "properties": {
+        "affinity": {
+          "$ref": "#/definitions/io.k8s.api.core.v1.Affinity",
+          "description": "The pod's scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/"
+        },
+        "containerTemplate": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
+        },
+        "imagePullSecrets": {
+          "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod",
+          "items": {
+            "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
+          },
+          "type": "array",
+          "x-kubernetes-patch-merge-key": "name",
+          "x-kubernetes-patch-strategy": "merge"
+        },
+        "initContainerTemplate": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
+        },
+        "metadata": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Metadata",
+          "description": "Metadata sets the pods's metadata, i.e. annotations and labels"
+        },
+        "nodeSelector": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
+          "type": "object"
+        },
+        "priority": {
+          "description": "The priority value. Various system components use this field to find the priority of the Redis pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/",
+          "format": "int32",
+          "type": "integer"
+        },
+        "priorityClassName": {
+          "description": "If specified, indicates the Redis pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/",
+          "type": "string"
+        },
+        "securityContext": {
+          "$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext",
+          "description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty.  See type description for default values of each field."
+        },
+        "serviceAccountName": {
+          "description": "ServiceAccountName applied to the pod",
+          "type": "string"
+        },
+        "tolerations": {
+          "description": "If specified, the pod's tolerations.",
+          "items": {
+            "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.Watermark": {
       "properties": {
         "disabled": {

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -18775,6 +18775,10 @@
         "job": {
           "description": "JobTemplate is used to customize Jobs",
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.JobTemplate"
+        },
+        "vertex": {
+          "description": "VertexTemplate is used to customize Vertices",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.VertexTemplate"
         }
       }
     },
@@ -19031,6 +19035,65 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.VertexTemplate": {
+      "type": "object",
+      "properties": {
+        "affinity": {
+          "description": "The pod's scheduling constraints More info: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/",
+          "$ref": "#/definitions/io.k8s.api.core.v1.Affinity"
+        },
+        "containerTemplate": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
+        },
+        "imagePullSecrets": {
+          "description": "ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/io.k8s.api.core.v1.LocalObjectReference"
+          },
+          "x-kubernetes-patch-merge-key": "name",
+          "x-kubernetes-patch-strategy": "merge"
+        },
+        "initContainerTemplate": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
+        },
+        "metadata": {
+          "description": "Metadata sets the pods's metadata, i.e. annotations and labels",
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Metadata"
+        },
+        "nodeSelector": {
+          "description": "NodeSelector is a selector which must be true for the pod to fit on a node. Selector which must match a node's labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/",
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "priority": {
+          "description": "The priority value. Various system components use this field to find the priority of the Redis pod. When Priority Admission Controller is enabled, it prevents users from setting this field. The admission controller populates this field from PriorityClassName. The higher the value, the higher the priority. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/",
+          "type": "integer",
+          "format": "int32"
+        },
+        "priorityClassName": {
+          "description": "If specified, indicates the Redis pod's priority. \"system-node-critical\" and \"system-cluster-critical\" are two special keywords which indicate the highest priorities with the former being the highest priority. Any other name must be defined by creating a PriorityClass object with that name. If not specified, the pod priority will be default or zero if there is no default. More info: https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/",
+          "type": "string"
+        },
+        "securityContext": {
+          "description": "SecurityContext holds pod-level security attributes and common container settings. Optional: Defaults to empty.  See type description for default values of each field.",
+          "$ref": "#/definitions/io.k8s.api.core.v1.PodSecurityContext"
+        },
+        "serviceAccountName": {
+          "description": "ServiceAccountName applied to the pod",
+          "type": "string"
+        },
+        "tolerations": {
+          "description": "If specified, the pod's tolerations.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/io.k8s.api.core.v1.Toleration"
+          }
+        }
+      }
+    },
     "io.numaproj.numaflow.v1alpha1.Watermark": {
       "type": "object",
       "properties": {