chore: enable automountServiceAccountToken and refine examples for qu…

…ick start. (#527) Signed-off-by: Derek Wang <whynowy@gmail.com>
numaproj · Feb 14, 2023 · 8dc71a5 · 8dc71a5
1 parent ac33fb0
commit 8dc71a5
Show file tree

Hide file tree

Showing 18 changed files with 838 additions and 631 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -17260,6 +17260,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "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": {
@@ -17317,6 +17321,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },
@@ -17534,6 +17542,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },
@@ -18091,6 +18103,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "bufferConfig": {
           "description": "Optional configuration for the streams, consumers and buckets to be created in this JetStream service, if specified, it will be merged with the default configuration in numaflow-controller-config. It accepts a YAML format configuration, it may include 4 sections, \"stream\", \"consumer\", \"otBucket\" and \"procBucket\". Available fields under \"stream\" include \"retention\" (e.g. interest, limits, workerQueue), \"maxMsgs\", \"maxAge\" (e.g. 72h), \"replicas\" (1, 3, 5), \"duplicates\" (e.g. 5m). Available fields under \"consumer\" include \"ackWait\" (e.g. 60s) Available fields under \"otBucket\" include \"maxValueSize\", \"history\", \"ttl\" (e.g. 72h), \"maxBytes\", \"replicas\" (1, 3, 5). Available fields under \"procBucket\" include \"maxValueSize\", \"history\", \"ttl\" (e.g. 72h), \"maxBytes\", \"replicas\" (1, 3, 5).",
           "type": "string"
@@ -18214,6 +18230,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "backoffLimit": {
           "description": "Specifies the number of retries before marking this job failed. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/#pod-backoff-failure-policy Numaflow defaults to 20",
           "format": "int32",
@@ -18369,6 +18389,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "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": {
@@ -19054,6 +19078,10 @@
           "$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/"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -17265,6 +17265,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "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",
@@ -17325,6 +17329,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },
@@ -17539,6 +17547,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },
@@ -18087,6 +18099,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "bufferConfig": {
           "description": "Optional configuration for the streams, consumers and buckets to be created in this JetStream service, if specified, it will be merged with the default configuration in numaflow-controller-config. It accepts a YAML format configuration, it may include 4 sections, \"stream\", \"consumer\", \"otBucket\" and \"procBucket\". Available fields under \"stream\" include \"retention\" (e.g. interest, limits, workerQueue), \"maxMsgs\", \"maxAge\" (e.g. 72h), \"replicas\" (1, 3, 5), \"duplicates\" (e.g. 5m). Available fields under \"consumer\" include \"ackWait\" (e.g. 60s) Available fields under \"otBucket\" include \"maxValueSize\", \"history\", \"ttl\" (e.g. 72h), \"maxBytes\", \"replicas\" (1, 3, 5). Available fields under \"procBucket\" include \"maxValueSize\", \"history\", \"ttl\" (e.g. 72h), \"maxBytes\", \"replicas\" (1, 3, 5).",
           "type": "string"
@@ -18210,6 +18226,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "backoffLimit": {
           "description": "Specifies the number of retries before marking this job failed. More info: https://kubernetes.io/docs/concepts/workloads/controllers/job/#pod-backoff-failure-policy Numaflow defaults to 20",
           "type": "integer",
@@ -18365,6 +18385,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "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",
@@ -19036,6 +19060,10 @@
           "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"
         },
+        "automountServiceAccountToken": {
+          "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted.",
+          "type": "boolean"
+        },
         "containerTemplate": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.ContainerTemplate"
         },

diff --git a/config/base/crds/full/numaflow.numaproj.io_interstepbufferservices.yaml b/config/base/crds/full/numaflow.numaproj.io_interstepbufferservices.yaml
@@ -398,6 +398,8 @@ spec:
                             type: array
                         type: object
                     type: object
+                  automountServiceAccountToken:
+                    type: boolean
                   bufferConfig:
                     type: string
                   containerTemplate:
@@ -1367,6 +1369,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       imagePullSecrets:
                         items:
                           properties:

diff --git a/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml b/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
@@ -490,6 +490,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       containerTemplate:
                         properties:
                           env:
@@ -1251,6 +1253,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       backoffLimit:
                         format: int32
                         type: integer
@@ -1872,6 +1876,8 @@ spec:
                               type: array
                           type: object
                       type: object
+                    automountServiceAccountToken:
+                      type: boolean
                     containerTemplate:
                       properties:
                         env:

diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -399,6 +399,8 @@ spec:
                         type: array
                     type: object
                 type: object
+              automountServiceAccountToken:
+                type: boolean
               containerTemplate:
                 properties:
                   env:

diff --git a/config/install.yaml b/config/install.yaml
@@ -397,6 +397,8 @@ spec:
                             type: array
                         type: object
                     type: object
+                  automountServiceAccountToken:
+                    type: boolean
                   bufferConfig:
                     type: string
                   containerTemplate:
@@ -1366,6 +1368,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       imagePullSecrets:
                         items:
                           properties:
@@ -2740,6 +2744,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       containerTemplate:
                         properties:
                           env:
@@ -3501,6 +3507,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       backoffLimit:
                         format: int32
                         type: integer
@@ -4122,6 +4130,8 @@ spec:
                               type: array
                           type: object
                       type: object
+                    automountServiceAccountToken:
+                      type: boolean
                     containerTemplate:
                       properties:
                         env:
@@ -7592,6 +7602,8 @@ spec:
                         type: array
                     type: object
                 type: object
+              automountServiceAccountToken:
+                type: boolean
               containerTemplate:
                 properties:
                   env:

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -397,6 +397,8 @@ spec:
                             type: array
                         type: object
                     type: object
+                  automountServiceAccountToken:
+                    type: boolean
                   bufferConfig:
                     type: string
                   containerTemplate:
@@ -1366,6 +1368,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       imagePullSecrets:
                         items:
                           properties:
@@ -2740,6 +2744,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       containerTemplate:
                         properties:
                           env:
@@ -3501,6 +3507,8 @@ spec:
                                 type: array
                             type: object
                         type: object
+                      automountServiceAccountToken:
+                        type: boolean
                       backoffLimit:
                         format: int32
                         type: integer
@@ -4122,6 +4130,8 @@ spec:
                               type: array
                           type: object
                       type: object
+                    automountServiceAccountToken:
+                      type: boolean
                     containerTemplate:
                       properties:
                         env:
@@ -7592,6 +7602,8 @@ spec:
                         type: array
                     type: object
                 type: object
+              automountServiceAccountToken:
+                type: boolean
               containerTemplate:
                 properties:
                   env:

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -189,6 +189,18 @@ empty definition that uses the default runtime handler. More info:
 </p>
 </td>
 </tr>
+<tr>
+<td>
+<code>automountServiceAccountToken</code></br> <em> bool </em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>
+AutomountServiceAccountToken indicates whether a service account token
+should be automatically mounted.
+</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="numaflow.numaproj.io/v1alpha1.AbstractVertex">

diff --git a/examples/0-isbsvc-jetstream.yaml b/examples/0-isbsvc-jetstream.yaml
@@ -9,3 +9,7 @@ metadata:
 spec:
   jetstream:
     version: latest # Do NOT use "latest" in real deployment, check "numaflow-controller-config" ConfigMap to get available versions.
+    # Optional. Specifying "persistence" will create a PersistentVolumeClaim for data persistence, it works for most of Kubernetes 
+    # clusters, including Kind, Minikube, K3s, etc, it's needed to run production workloads.
+    persistence:
+      volumeSize: 3Gi
diff --git a/examples/2-even-odd-pipeline.yaml b/examples/2-even-odd-pipeline.yaml
@@ -8,18 +8,26 @@ spec:
       source:
         http: {}
     - name: even-or-odd
+      scale:
+        min: 1
       udf:
         container:
           # Tell the input number is even or odd, see https://github.com/numaproj/numaflow-go/tree/main/pkg/function/examples/even_odd
           image: quay.io/numaio/numaflow-go/map-even-odd
     - name: even-sink
+      scale:
+        min: 1
       sink:
         # A simple log printing sink
         log: {}
     - name: odd-sink
+      scale:
+        min: 1
       sink:
         log: {}
     - name: number-sink
+      scale:
+        min: 1
       sink:
         log: {}
   edges: