├── .gitignore ├── CNAME ├── LICENSE ├── README.md ├── dcos.md ├── img ├── concept.png └── session.png └── main.go /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | dnpipes 3 | 4 | # Compiled Object files, Static and Dynamic libs (Shared Objects) 5 | *.o 6 | *.a 7 | *.so 8 | 9 | # Folders 10 | _obj 11 | _test 12 | 13 | # Architecture specific extensions/prefixes 14 | *.[568vq] 15 | [568vq].out 16 | 17 | *.cgo1.go 18 | *.cgo2.c 19 | _cgo_defun.c 20 | _cgo_gotypes.go 21 | _cgo_export.* 22 | 23 | _testmain.go 24 | 25 | *.exe 26 | *.test 27 | *.prof 28 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- 1 | dnpip.es -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # dnpipes 2 | 3 | Distributed Named Pipes (or: `dnpipes`) are essentially a distributed version of Unix [named pipes](http://en.wikipedia.org/wiki/Named_pipe) comparable to, for example, [SQS](https://aws.amazon.com/sqs/) in AWS or the [Service Bus](https://azure.microsoft.com/en-us/services/service-bus/) in Azure. 4 | 5 | ![dnpipes concept](img/concept.png) 6 | 7 | Conceptually, we're dealing with a bunch of distributed processes (`dpN` above). These distributed processes may be long-running (such as `dp0` or `dp5`) or batch-oriented ones, for example `dp3` or `dp6`. There are a number of [situations](#use-cases) where you want these distributed processes to communicate, very similar to what [IPC](http://tldp.org/LDP/lpg/node7.html) enables you to do on a single machine. Now, `dnpipes` are a simple mechanism to facilitate IPC between distributed processes. What follows is an [interface specification](#interface-specification) as well as a [reference implementation](#reference-implementation) for `dnpipes`. 8 | 9 | ## Interface specification 10 | 11 | Interpret the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", "MAY NOT", and "OPTIONAL" in the context of this repo as defined in [RFC 2119](https://tools.ietf.org/html/rfc2119). 12 | 13 | A `dnpipe` is a distributed ordered queue (FIFO) of messages available to a number of participating distributed processes. A distributed process is a useful abstraction provided by systems such as DC/OS (for example a Marathon app or a Metronome job) or Kubernetes (ReplicaSet or a Job) that give a user the illusion that a service or application she is executing on a bunch of commodity machines (the cluster) behaves like one global entity while it really is a collection of locally executed processes. In DC/OS this locally executed process would be a [Mesos task](http://mesos.apache.org/documentation/latest/architecture/) and in Kubernetes a [pod](http://kubernetes.io/docs/api-reference/v1/definitions/#_v1_podspec). 14 | 15 | 16 | A `dnpipes` implementation MUST support the following operations: 17 | 18 | - `push(TOPIC, MSG)` … executed by a publisher, this writes the message `MSG` to a `dnpipe` called `TOPIC`. 19 | - `MSG <- pull(TOPIC)` … executed by a subscriber, this reads a message from a `dnpipe` called `TOPIC`. 20 | - `reset(TOPIC)` … executed by either a publisher or consumer, this removes all messages from a `dnpipe` called `TOPIC`. 21 | 22 | The following MUST be true at any point in time: 23 | 24 | 1. After `push` is executed by the publisher `MSG` MUST be available for `pull` to any participant until `reset` is triggered and has completed. 25 | 1. A `pull` does not remove a message from a `dnpipe`, it merely delivers its content to the consumer. 26 | 1. The way how participants discover a `dnpipe` is outside of the scope of this specification. 27 | 28 | Note concerning the last point: since there are many ways to implement service discovery in a distributed system we do not expect that an agreement can be found here hence we leave it up to the implementation how to go about it. The next sections shows an example using Kafka and DNS to achieve this. 29 | 30 | ## Use cases 31 | 32 | A `dnpipe` can be useful in a number of situations including but not limited to the following: 33 | 34 | - To implement a work queue with, for example: [Adron/testing-aws-sqs-worker](https://github.com/Adron/testing-aws-sqs-worker) 35 | - To do event dispatching in microservices, for example: [How we build microservices at Karma](https://blog.karmawifi.com/how-we-build-microservices-at-karma-71497a89bfb4) 36 | - To coordinate Function-as-a-Service executions, for example: [Integrate SQS and Lambda: serverless architecture for asynchronous workloads](https://cloudonaut.io/integrate-sqs-and-lambda-serverless-architecture-for-asynchronous-workloads/) 37 | -------------------------------------------------------------------------------- /dcos.md: -------------------------------------------------------------------------------- 1 | # A Mesos reference implementation 2 | 3 | This reference implementation of `dnpipes` is based on [DC/OS](https://dcos.io) using [Apache Kafka](http://kafka.apache.org/). 4 | 5 | ## Install 6 | 7 | From source: 8 | 9 | ```bash 10 | $ go get github.com/mhausenblas/dnpipes 11 | $ go build 12 | $ sudo mv dnpipes /usr/local/dnpipes 13 | ``` 14 | 15 | From binaries, for Linux: 16 | 17 | ```bash 18 | $ curl -s -L https://github.com/mhausenblas/dnpipes/releases/download/0.1.0/linux-dnpipes -o dnpipes 19 | $ sudo mv dnpipes /usr/local/dnpipes 20 | $ sudo chmod +x /usr/local/bin/dnpipes 21 | ``` 22 | 23 | From binaries, for macOS: 24 | 25 | ```bash 26 | $ curl -s -L https://github.com/mhausenblas/dnpipes/releases/download/0.1.0/macos-dnpipes -o dnpipes 27 | $ sudo mv dnpipes /usr/local/dnpipes 28 | $ sudo chmod +x /usr/local/bin/dnpipes 29 | ``` 30 | 31 | ## Example session 32 | 33 | To try it out yourself, you first need a to [install a DC/OS cluster](https://dcos.io/install/) and then Apache Kafka like so: 34 | 35 | ```bash 36 | $ dcos package install kafka 37 | ``` 38 | 39 | Note that if you are unfamiliar with Kafka and its terminology, you can check out the respective [Kafka 101 example](https://github.com/dcos/examples/tree/master/1.8/kafka) now. 40 | 41 | Next, figure out where the brokers are (in my case I started Kafka with one broker): 42 | 43 | ```bash 44 | $ dcos kafka connection 45 | 46 | { 47 | "address": [ 48 | "10.0.2.94:9951" 49 | ], 50 | "zookeeper": "master.mesos:2181/dcos-service-kafka", 51 | "dns": [ 52 | "broker-0.kafka.mesos:9951" 53 | ], 54 | "vip": "broker.kafka.l4lb.thisdcos.directory:9092" 55 | } 56 | ``` 57 | Now, an example session using the `dnpipes` reference implementation looks as follows. 58 | I've set up two terminals, in one I'm starting the `dnpipes` in publisher mode: 59 | 60 | ```bash 61 | $ ./dnpipes --mode=publisher --broker=broker-0.kafka.mesos:9951 --topic=test 62 | > hello! 63 | > bye 64 | > RESET 65 | 2016/12/11 13:38:57 Connected to 10.0.6.130:2181 66 | 2016/12/11 13:38:57 Authenticated: id=97087250213175381, timeout=4000 67 | [0] - &{Czxid:295 Mzxid:295 Ctime:1481463523762 Mtime:1481463523762 Version:0 Cversion:1 Aversion:0 EphemeralOwner:0 DataLength:0 NumChildren:1 Pzxid:296} 68 | reset this dnpipes 69 | > ^C 70 | ``` 71 | 72 | The second terminal has `dnpipes` in subscriber mode running: 73 | 74 | ```bash 75 | $ ./dnpipes --mode=subscriber --broker=broker-0.kafka.mesos:9951 --topic=test 2>/dev/null 76 | hello! 77 | bye 78 | ^C 79 | ``` 80 | 81 | And here's a screen shot of the whole thing: 82 | 83 | ![screen shot of example dnpipes session](img/session.png) 84 | -------------------------------------------------------------------------------- /img/concept.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mhausenblas/dnpipes/0000cef3b1261b43def72aff708c4fef2bdfef1d/img/concept.png -------------------------------------------------------------------------------- /img/session.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mhausenblas/dnpipes/0000cef3b1261b43def72aff708c4fef2bdfef1d/img/session.png -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "flag" 5 | "fmt" 6 | "github.com/Shopify/sarama" 7 | log "github.com/Sirupsen/logrus" 8 | "github.com/samuel/go-zookeeper/zk" 9 | "os" 10 | "time" 11 | ) 12 | 13 | const ( 14 | VERSION string = "0.1.0" 15 | MODE_PUBLISHER = "publisher" 16 | MODE_SUBSCRIBER = "subscriber" 17 | ) 18 | 19 | var ( 20 | version bool 21 | // operations mode of this agent: 22 | omode string 23 | // FQDN/IP + port of a Kafka broker: 24 | broker string 25 | // the active Kafka topic: 26 | topic string 27 | // the Kafka producer: 28 | producer sarama.SyncProducer 29 | ) 30 | 31 | func init() { 32 | flag.BoolVar(&version, "version", false, "Display version information") 33 | flag.StringVar(&omode, "mode", MODE_SUBSCRIBER, fmt.Sprintf("The operations mode of this agent, can be either \"%s\" or \"%s\".", MODE_PUBLISHER, MODE_SUBSCRIBER)) 34 | flag.StringVar(&broker, "broker", "", "The FQDN or IP address and port of a Kafka broker. Example: broker-1.kafka.mesos:9382 or localhost:9092") 35 | flag.StringVar(&topic, "topic", "", "The topic to publish to or pull from. Example: test") 36 | 37 | flag.Usage = func() { 38 | fmt.Printf("Usage: %s [args]\n\n", os.Args[0]) 39 | fmt.Println("Arguments:") 40 | flag.PrintDefaults() 41 | } 42 | flag.Parse() 43 | } 44 | 45 | func about() { 46 | fmt.Printf("This is the dnpipes reference implementation in version %s\n", VERSION) 47 | } 48 | 49 | func handleReset() { 50 | zks := []string{"leader.mesos:2181"} 51 | conn, _, _ := zk.Connect(zks, time.Second) 52 | partitions, stat, _ := conn.Children("/dcos-service-kafka/brokers/topics/" + topic + "/partitions") 53 | fmt.Println(fmt.Sprintf("%+v - %+v", partitions, stat)) 54 | for _, p := range partitions { 55 | if err := conn.Delete("/dcos-service-kafka/brokers/topics/"+topic+"/partitions/"+p+"/state", -1); err != nil { 56 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error("There was a problem resetting the topic:", err) 57 | } 58 | if err := conn.Delete("/dcos-service-kafka/brokers/topics/"+topic+"/partitions/"+p, -1); err != nil { 59 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error("There was a problem resetting the topic:", err) 60 | } 61 | } 62 | if err := conn.Delete("/dcos-service-kafka/brokers/topics/"+topic+"/partitions", -1); err != nil { 63 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error("There was a problem resetting the topic:", err) 64 | } 65 | if err := conn.Delete("/dcos-service-kafka/brokers/topics/"+topic, -1); err != nil { 66 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error("There was a problem resetting the topic:", err) 67 | } 68 | fmt.Println("reset this dnpipes") 69 | } 70 | 71 | func handlePublisher() { 72 | if p, err := sarama.NewSyncProducer([]string{broker}, nil); err != nil { 73 | log.Error(err) 74 | os.Exit(1) 75 | } else { 76 | producer = p 77 | } 78 | defer func() { 79 | if err := producer.Close(); err != nil { 80 | log.Error(err) 81 | os.Exit(1) 82 | } 83 | }() 84 | imsg := "" 85 | for { 86 | fmt.Print("> ") 87 | fmt.Scanln(&imsg) 88 | if imsg == "RESET" { 89 | handleReset() 90 | } else { 91 | msg := &sarama.ProducerMessage{Topic: string(topic), Value: sarama.StringEncoder(imsg)} 92 | if _, _, err := producer.SendMessage(msg); err != nil { 93 | log.WithFields(log.Fields{"func": "handlePublisher"}).Error("Failed to send message ", err) 94 | } else { 95 | log.Debug(fmt.Sprintf("%#v", msg)) 96 | } 97 | } 98 | } 99 | } 100 | 101 | func handleSubscriber() { 102 | var consumer sarama.Consumer 103 | if c, err := sarama.NewConsumer([]string{broker}, nil); err != nil { 104 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error(err) 105 | return 106 | } else { 107 | consumer = c 108 | } 109 | defer func() { 110 | if err := consumer.Close(); err != nil { 111 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error(err) 112 | } 113 | }() 114 | 115 | if partitionConsumer, err := consumer.ConsumePartition(topic, 0, sarama.OffsetNewest); err != nil { 116 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error(err) 117 | return 118 | } else { 119 | defer func() { 120 | if err := partitionConsumer.Close(); err != nil { 121 | log.WithFields(log.Fields{"func": "handleSubscriber"}).Error(err) 122 | } 123 | }() 124 | for { 125 | msg := <-partitionConsumer.Messages() 126 | log.Debug(fmt.Sprintf("%#v", msg)) 127 | fmt.Println(string(msg.Value)) 128 | } 129 | } 130 | } 131 | 132 | func main() { 133 | if version { 134 | about() 135 | os.Exit(0) 136 | } 137 | if broker == "" { 138 | flag.Usage() 139 | os.Exit(1) 140 | } 141 | 142 | switch omode { 143 | case MODE_PUBLISHER: 144 | handlePublisher() 145 | case MODE_SUBSCRIBER: 146 | handleSubscriber() 147 | default: 148 | fmt.Println("Usage error, you provided an unknown mode") 149 | flag.Usage() 150 | os.Exit(1) 151 | } 152 | } 153 | --------------------------------------------------------------------------------