feat: add blackhole sink. Closes #329 (#330)

Signed-off-by: Vigith Maurice <vigith@gmail.com>
numaproj · Nov 18, 2022 · 3d936a5 · 3d936a5
1 parent 4590547
commit 3d936a5
Show file tree

Hide file tree

Showing 19 changed files with 971 additions and 381 deletions.
diff --git a/api/json-schema/schema.json b/api/json-schema/schema.json
@@ -17420,6 +17420,10 @@
       },
       "type": "object"
     },
+    "io.numaproj.numaflow.v1alpha1.Blackhole": {
+      "description": "Blackhole is a sink to emulate /dev/null",
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.Buffer": {
       "properties": {
         "Name": {
@@ -18725,6 +18729,9 @@
     },
     "io.numaproj.numaflow.v1alpha1.Sink": {
       "properties": {
+        "blackhole": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Blackhole"
+        },
         "kafka": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.KafkaSink"
         },

diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
@@ -17424,6 +17424,10 @@
         }
       }
     },
+    "io.numaproj.numaflow.v1alpha1.Blackhole": {
+      "description": "Blackhole is a sink to emulate /dev/null",
+      "type": "object"
+    },
     "io.numaproj.numaflow.v1alpha1.Buffer": {
       "type": "object",
       "required": [
@@ -18712,6 +18716,9 @@
     "io.numaproj.numaflow.v1alpha1.Sink": {
       "type": "object",
       "properties": {
+        "blackhole": {
+          "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.Blackhole"
+        },
         "kafka": {
           "$ref": "#/definitions/io.numaproj.numaflow.v1alpha1.KafkaSink"
         },

diff --git a/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml b/config/base/crds/full/numaflow.numaproj.io_pipelines.yaml
@@ -3466,6 +3466,8 @@ spec:
                       type: array
                     sink:
                       properties:
+                        blackhole:
+                          type: object
                         kafka:
                           properties:
                             brokers:

diff --git a/config/base/crds/full/numaflow.numaproj.io_vertices.yaml b/config/base/crds/full/numaflow.numaproj.io_vertices.yaml
@@ -2038,6 +2038,8 @@ spec:
                 type: array
               sink:
                 properties:
+                  blackhole:
+                    type: object
                   kafka:
                     properties:
                       brokers:

diff --git a/config/install.yaml b/config/install.yaml
@@ -5687,6 +5687,8 @@ spec:
                       type: array
                     sink:
                       properties:
+                        blackhole:
+                          type: object
                         kafka:
                           properties:
                             brokers:
@@ -8942,6 +8944,8 @@ spec:
                 type: array
               sink:
                 properties:
+                  blackhole:
+                    type: object
                   kafka:
                     properties:
                       brokers:

diff --git a/config/namespace-install.yaml b/config/namespace-install.yaml
@@ -5687,6 +5687,8 @@ spec:
                       type: array
                     sink:
                       properties:
+                        blackhole:
+                          type: object
                         kafka:
                           properties:
                             brokers:
@@ -8942,6 +8944,8 @@ spec:
                 type: array
               sink:
                 properties:
+                  blackhole:
+                    type: object
                   kafka:
                     properties:
                       brokers:

diff --git a/docs/APIs.md b/docs/APIs.md
@@ -367,6 +367,18 @@ needs to add “Authorization: Bearer <token>” in the header
 </tr>
 </tbody>
 </table>
+<h3 id="numaflow.numaproj.io/v1alpha1.Blackhole">
+Blackhole
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#numaflow.numaproj.io/v1alpha1.Sink">Sink</a>)
+</p>
+<p>
+<p>
+Blackhole is a sink to emulate /dev/null
+</p>
+</p>
 <h3 id="numaflow.numaproj.io/v1alpha1.Buffer">
 Buffer
 </h3>
@@ -3326,6 +3338,14 @@ Log </a> </em>
 </tr>
 <tr>
 <td>
+<code>blackhole</code></br> <em>
+<a href="#numaflow.numaproj.io/v1alpha1.Blackhole"> Blackhole </a> </em>
+</td>
+<td>
+</td>
+</tr>
+<tr>
+<td>
 <code>udsink</code></br> <em>
 <a href="#numaflow.numaproj.io/v1alpha1.UDSink"> UDSink </a> </em>
 </td>

diff --git a/docs/sinks/blackhole.md b/docs/sinks/blackhole.md
@@ -0,0 +1,11 @@
+# Blackhole Sink
+
+A `Blackhole` sink is where the output is drained without writing to any sink, it is to emulate `/dev/null`.
+
+```yaml
+spec:
+  vertices:
+    - name: output
+      sink:
+        blackhole: {}
+```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -51,6 +51,7 @@ nav:
       - Sinks:
           - sinks/kafka.md
           - sinks/log.md
+          - sinks/blackhole.md
           - User Defined Sinks: "sinks/user-defined-sinks.md"
       - User Defined Functions:
           - Overview: "user-defined-functions.md"

diff --git a/pkg/apis/numaflow/v1alpha1/blackhole_sink.go b/pkg/apis/numaflow/v1alpha1/blackhole_sink.go
@@ -0,0 +1,21 @@
+/*
+Copyright 2022 The Numaproj Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+// Blackhole is a sink to emulate /dev/null
+type Blackhole struct {
+}